settings.h revision 358a99c385080f7f31166943f3ac3a2aea6b5263
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * Settings file data structures.
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * These structures are created by the settings file loader and filled with values
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * copied from the raw XML data. This allows us to finally make the XML reader
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * version-independent and read VirtualBox XML files from earlier versions without
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * requiring complicated, tedious and error-prone XSLT conversions.
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * Note: Headers in Main code have been tweaked to only declare the structures
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * defined here so that this header need only be included from code files that
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * actually use these structures.
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * Copyright (C) 2007-2009 Sun Microsystems, Inc.
d46ee884c41b808b239563b1978468aae12e33a2vboxsync * This file is part of VirtualBox Open Source Edition (OSE), as
d46ee884c41b808b239563b1978468aae12e33a2vboxsync * available from http://www.virtualbox.org. This file is free software;
d46ee884c41b808b239563b1978468aae12e33a2vboxsync * you can redistribute it and/or modify it under the terms of the GNU
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * General Public License (GPL) as published by the Free Software
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Foundation, in version 2 as it comes in the "COPYING" file of the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * The contents of this file may alternatively be used under the terms
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * of the Common Development and Distribution License Version 1.0
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * VirtualBox OSE distribution, in which case the provisions of the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * CDDL are applicable instead of those of the GPL.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * You may elect to license modified versions of this file under the
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * terms and conditions of either the GPL or the CDDL or both.
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * Clara, CA 95054 USA or visit http://www.sun.com if you need
1c94c0a63ba68be1a7b2c640e70d7a06464e4fcavboxsync * additional information or have any questions.
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync////////////////////////////////////////////////////////////////////////////////
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync// Helper classes
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync////////////////////////////////////////////////////////////////////////////////
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync// ExtraDataItem (used by both VirtualBox.xml and machines XML)
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::map<com::Utf8Str, com::Utf8Str> ExtraDataItemsMap;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::list<USBDeviceFilter> USBDeviceFiltersList;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * Common base class for both MainConfigFile and MachineConfigFile
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync * which contains some common logic for both.
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readExtraData(const xml::ElementNode &elmExtraData,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readUSBDeviceFilters(const xml::ElementNode &elmDeviceFilters,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void writeExtraData(xml::ElementNode &elmParent, const ExtraDataItemsMap &me);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void writeUSBDeviceFilters(xml::ElementNode &elmParent,
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync////////////////////////////////////////////////////////////////////////////////
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync////////////////////////////////////////////////////////////////////////////////
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync USBDeviceFilterAction_T action; // only used with host USB filters
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Utf8Str strRemote; // irrelevant for host USB objects
fd0cf98cb3eafc5c96b7e95d934b01c5df4785fbvboxsync uint32_t ulMaskedInterfaces; // irrelevant for host USB objects
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::map<com::Utf8Str, com::Utf8Str> PropertiesMap;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync // the following are for hard disks only:
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync bool fAutoReset; // optional, only for diffs, default is false
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::list<MachineRegistryEntry> MachinesRegistry;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync typedef enum {Error, HardDisk, DVDImage, FloppyImage} MediaType;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readMedium(MediaType t, const xml::ElementNode &elmMedium, MediaList &llMedia);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readMediaRegistry(const xml::ElementNode &elmMediaRegistry);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readMachineRegistry(const xml::ElementNode &elmMachineRegistry);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readDHCPServers(const xml::ElementNode &elmDHCPServers);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync////////////////////////////////////////////////////////////////////////////////
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync// Machine XML structures
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync////////////////////////////////////////////////////////////////////////////////
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Guid uuid; // if != NULL, UUID of mounted ISO image
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Utf8Str strHostDriveSrc; // if != NULL, value of <HostDrive>/@src
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Guid uuid; // if != NULL, UUID of mounted ISO image
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Utf8Str strHostDriveSrc; // if != NULL, value of <HostDrive>/@src
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Utf8Str strName; // with NAT: nat network or empty;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync // with bridged: host interface or empty;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync // otherwise: network name (required)
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::list<NetworkAdapter> NetworkAdaptersList;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::list<GuestProperty> GuestPropertiesList;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::map<uint32_t, DeviceType_T> BootOrderMap;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync/* mBootOrder [0] = DeviceType_Floppy;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync mBootOrder [1] = DeviceType_DVD;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync mBootOrder [2] = DeviceType_HardDisk;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync for (size_t i = 3; i < RT_ELEMENTS (mBootOrder); i++)
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync mBootOrder [i] = DeviceType_Null;*/
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Utf8Str strVersion; // hardware version, optional
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync BootOrderMap mapBootOrder; // item 0 has highest priority
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync fAccelerate2DVideo; // requires settings version 1.8 (VirtualBox 3.1)
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync // technically these two have no business in the hardware section, but for some
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync // clever reason <Hardware> is where they are in the XML....
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync enum { HardDisk } type; // @todo: implement DVD attachments here
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::list<AttachedDevice> AttachedDevicesList;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync // only for when controllerType == StorageControllerType_IntelAhci:
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsynctypedef std::list<StorageController> StorageControllersList;
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync// wrap the list into an extra struct so we can use the struct without
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync// having to define the typedef above in headers
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync com::Utf8Str strStateFile; // for online snapshots only
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync MachineConfigFile(const com::Utf8Str *pstrFilename);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readNetworkAdapters(const xml::ElementNode &elmHardware, NetworkAdaptersList &ll);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readSerialPorts(const xml::ElementNode &elmUART, SerialPortsList &ll);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readParallelPorts(const xml::ElementNode &elmLPT, ParallelPortsList &ll);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readGuestProperties(const xml::ElementNode &elmGuestProperties, Hardware &hw);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readHardware(const xml::ElementNode &elmHardware, Hardware &hw);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readStorageControllers(const xml::ElementNode &elmStorageControllers, Storage &strg);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readSnapshot(const xml::ElementNode &elmSnapshot, Snapshot &snap);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void readMachine(const xml::ElementNode &elmMachine);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void writeHardware(xml::ElementNode &elmParent, const Hardware &hw);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void writeStorageControllers(xml::ElementNode &elmParent, const Storage &st);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync void writeSnapshot(xml::ElementNode &elmParent, const Snapshot &snap);
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync bool fCurrentStateModified; // optional, default is true
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync RTTIMESPEC timeLastStateChange; // optional, defaults to now
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync SnapshotsList llFirstSnapshot; // first snapshot or empty list if there's none
fe06619ae576367ff3568e6abd99fb8ad28cc73avboxsync} // namespace settings
d46ee884c41b808b239563b1978468aae12e33a2vboxsync#endif /* ___VBox_settings_h */