SharedFolderImpl.h revision 0ce6ae9d6efed5d54222a13bbdabce9e688e4447
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync/** @file
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync *
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * VirtualBox COM class implementation
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync */
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync/*
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * Copyright (C) 2006-2009 Sun Microsystems, Inc.
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync *
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * available from http://www.virtualbox.org. This file is free software;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * you can redistribute it and/or modify it under the terms of the GNU
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * General Public License (GPL) as published by the Free Software
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync *
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync * additional information or have any questions.
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync */
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync#ifndef ____H_SHAREDFOLDERIMPL
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync#define ____H_SHAREDFOLDERIMPL
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync#include "VirtualBoxBase.h"
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync#include <VBox/shflsvc.h>
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncclass Machine;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncclass Console;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncclass VirtualBox;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncclass ATL_NO_VTABLE SharedFolder :
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync public VirtualBoxBaseNEXT,
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync public VirtualBoxSupportErrorInfoImpl <SharedFolder, ISharedFolder>,
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync public VirtualBoxSupportTranslation <SharedFolder>,
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync VBOX_SCRIPTABLE_IMPL(ISharedFolder)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync{
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncpublic:
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync struct Data
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync {
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync Data() {}
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const Bstr name;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const Bstr hostPath;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync BOOL writable;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync Bstr lastAccessError;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync };
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync VIRTUALBOXBASE_ADD_ERRORINFO_SUPPORT (SharedFolder)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync DECLARE_NOT_AGGREGATABLE(SharedFolder)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync DECLARE_PROTECT_FINAL_CONSTRUCT()
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync BEGIN_COM_MAP(SharedFolder)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync COM_INTERFACE_ENTRY(ISupportErrorInfo)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync COM_INTERFACE_ENTRY(ISharedFolder)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync END_COM_MAP()
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync NS_DECL_ISUPPORTS
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync DECLARE_EMPTY_CTOR_DTOR (SharedFolder)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync HRESULT FinalConstruct();
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync void FinalRelease();
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // public initializer/uninitializer for internal purposes only
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync HRESULT init (Machine *aMachine, CBSTR aName, CBSTR aHostPath, BOOL aWritable);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync HRESULT initCopy (Machine *aMachine, SharedFolder *aThat);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync HRESULT init (Console *aConsole, CBSTR aName, CBSTR aHostPath, BOOL aWritable);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync HRESULT init (VirtualBox *aVirtualBox, CBSTR aName, CBSTR aHostPath, BOOL aWritable);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync void uninit();
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // ISharedFolder properties
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync STDMETHOD(COMGETTER(Name)) (BSTR *aName);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync STDMETHOD(COMGETTER(HostPath)) (BSTR *aHostPath);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync STDMETHOD(COMGETTER(Accessible)) (BOOL *aAccessible);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync STDMETHOD(COMGETTER(Writable)) (BOOL *aWritable);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync STDMETHOD(COMGETTER(LastAccessError)) (BSTR *aLastAccessError);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // public methods for internal purposes only
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // (ensure there is a caller and a read lock before calling them!)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // public methods that don't need a lock (because access constant data)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // (ensure there is a caller added before calling them!)
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const Bstr &name() const { return m.name; }
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const Bstr &hostPath() const { return m.hostPath; }
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync BOOL writable() const { return m.writable; }
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync // for VirtualBoxSupportErrorInfoImpl
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync static const wchar_t *getComponentName() { return L"SharedFolder"; }
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncprotected:
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync HRESULT protectedInit (VirtualBoxBaseWithChildrenNEXT *aParent,
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync CBSTR aName, CBSTR aHostPath, BOOL aWritable);
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsyncprivate:
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync VirtualBoxBaseWithChildrenNEXT *const mParent;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync /* weak parents (only one of them is not null) */
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const ComObjPtr <Machine, ComWeakRef> mMachine;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const ComObjPtr <Console, ComWeakRef> mConsole;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync const ComObjPtr <VirtualBox, ComWeakRef> mVirtualBox;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync Data m;
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync};
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync#endif // ____H_SHAREDFOLDERIMPL
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync/* vi: set tabstop=4 shiftwidth=4 expandtab: */
8c48cf39dfb84c1f26e0e7fbd1c407e25a34eef1vboxsync