VirtualBox

source: vbox/trunk/src/VBox/Main/include/SerialPortImpl.h@ 16560

Last change on this file since 16560 was 15051, checked in by vboxsync, 15 years ago

Main: Cleaned up the long standing const BSTR = const (OLECHAR *) on WIn32 vs (const PRunichar) * on XPCOM clash. Cleaned up BSTR/GUID macros (IN_BSTR replaces INPTR BSTR, IN_GUID replaces INPTR GUIDPARAM, OUT_GUID replaces GUIDPARAMOUT).

  • Property svn:eol-style set to native
File size: 4.2 KB
Line 
1/* $Id$ */
2
3/** @file
4 *
5 * VirtualBox COM class implementation
6 */
7
8/*
9 * Copyright (C) 2006-2007 Sun Microsystems, Inc.
10 *
11 * This file is part of VirtualBox Open Source Edition (OSE), as
12 * available from http://www.virtualbox.org. This file is free software;
13 * you can redistribute it and/or modify it under the terms of the GNU
14 * General Public License (GPL) as published by the Free Software
15 * Foundation, in version 2 as it comes in the "COPYING" file of the
16 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
17 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
18 *
19 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
20 * Clara, CA 95054 USA or visit http://www.sun.com if you need
21 * additional information or have any questions.
22 */
23
24#ifndef ____H_SERIALPORTIMPL
25#define ____H_SERIALPORTIMPL
26
27#include "VirtualBoxBase.h"
28
29class Machine;
30
31class ATL_NO_VTABLE SerialPort :
32 public VirtualBoxBaseNEXT,
33 public VirtualBoxSupportErrorInfoImpl <SerialPort, ISerialPort>,
34 public VirtualBoxSupportTranslation <SerialPort>,
35 public ISerialPort
36{
37public:
38
39 struct Data
40 {
41 Data()
42 : mSlot (0)
43 , mEnabled (FALSE)
44 , mIRQ (4)
45 , mIOBase (0x3f8)
46 , mHostMode (PortMode_Disconnected)
47 , mServer (FALSE)
48 {}
49
50 bool operator== (const Data &that) const
51 {
52 return this == &that ||
53 (mSlot == that.mSlot &&
54 mEnabled == that.mEnabled &&
55 mIRQ == that.mIRQ &&
56 mIOBase == that.mIOBase &&
57 mHostMode == that.mHostMode &&
58 mPath == that.mPath &&
59 mServer == that.mServer);
60 }
61
62 ULONG mSlot;
63 BOOL mEnabled;
64 ULONG mIRQ;
65 ULONG mIOBase;
66 PortMode_T mHostMode;
67 Bstr mPath;
68 BOOL mServer;
69 };
70
71 VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (SerialPort)
72
73 DECLARE_NOT_AGGREGATABLE(SerialPort)
74
75 DECLARE_PROTECT_FINAL_CONSTRUCT()
76
77 BEGIN_COM_MAP(SerialPort)
78 COM_INTERFACE_ENTRY(ISupportErrorInfo)
79 COM_INTERFACE_ENTRY(ISerialPort)
80 END_COM_MAP()
81
82 NS_DECL_ISUPPORTS
83
84 DECLARE_EMPTY_CTOR_DTOR (SerialPort)
85
86 HRESULT FinalConstruct();
87 void FinalRelease();
88
89 // public initializer/uninitializer for internal purposes only
90 HRESULT init (Machine *aParent, ULONG aSlot);
91 HRESULT init (Machine *aParent, SerialPort *aThat);
92 HRESULT initCopy (Machine *parent, SerialPort *aThat);
93 void uninit();
94
95 // ISerialPort properties
96 STDMETHOD(COMGETTER(Slot)) (ULONG *aSlot);
97 STDMETHOD(COMGETTER(Enabled)) (BOOL *aEnabled);
98 STDMETHOD(COMSETTER(Enabled)) (BOOL aEnabled);
99 STDMETHOD(COMGETTER(HostMode)) (PortMode_T *aHostMode);
100 STDMETHOD(COMSETTER(HostMode)) (PortMode_T aHostMode);
101 STDMETHOD(COMGETTER(IRQ)) (ULONG *aIRQ);
102 STDMETHOD(COMSETTER(IRQ)) (ULONG aIRQ);
103 STDMETHOD(COMGETTER(IOBase) ) (ULONG *aIOBase);
104 STDMETHOD(COMSETTER(IOBase)) (ULONG aIOBase);
105 STDMETHOD(COMGETTER(Path)) (BSTR *aPath);
106 STDMETHOD(COMSETTER(Path)) (IN_BSTR aPath);
107 STDMETHOD(COMGETTER(Server)) (BOOL *aServer);
108 STDMETHOD(COMSETTER(Server)) (BOOL aServer);
109
110 // public methods only for internal purposes
111
112 HRESULT loadSettings (const settings::Key &aPortNode);
113 HRESULT saveSettings (settings::Key &aPortNode);
114
115 bool isModified() { AutoWriteLock alock (this); return mData.isBackedUp(); }
116 bool isReallyModified() { AutoWriteLock alock (this); return mData.hasActualChanges(); }
117 bool rollback();
118 void commit();
119 void copyFrom (SerialPort *aThat);
120
121 // public methods for internal purposes only
122 // (ensure there is a caller and a read lock before calling them!)
123
124 // for VirtualBoxSupportErrorInfoImpl
125 static const wchar_t *getComponentName() { return L"SerialPort"; }
126
127private:
128
129 HRESULT checkSetPath (CBSTR aPath);
130
131 const ComObjPtr <Machine, ComWeakRef> mParent;
132 const ComObjPtr <SerialPort> mPeer;
133
134 Backupable <Data> mData;
135};
136
137#endif // ____H_FLOPPYDRIVEIMPL
138/* vi: set tabstop=4 shiftwidth=4 expandtab: */
Note: See TracBrowser for help on using the repository browser.

© 2023 Oracle
ContactPrivacy policyTerms of Use