tstVBoxAPILinux.cpp revision 4f7bc3e9b035984d494d38afa2913fa560e259d6
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * tstVBoxAPILinux - sample program to illustrate the VirtualBox
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * XPCOM API for machine management on Linux.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * It only uses standard C/C++ and XPCOM semantics,
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * no additional VBox classes/macros/helpers.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Copyright (C) 2006-2007 Sun Microsystems, Inc.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * This file is part of VirtualBox Open Source Edition (OSE), as
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * available from http://www.virtualbox.org. This file is free software;
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * you can redistribute it and/or modify it under the terms of the GNU
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * General Public License (GPL) as published by the Free Software
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Foundation, in version 2 as it comes in the "COPYING" file of the
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Clara, CA 95054 USA or visit http://www.sun.com if you need
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * additional information or have any questions.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * PURPOSE OF THIS SAMPLE PROGRAM
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * ------------------------------
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * This sample program is intended to demonstrate the minimal code necessary
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * to use VirtualBox XPCOM API for learning puroses only. The program uses
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * pure XPCOM and doesn't have any extra dependencies to let you better
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * understand what is going on when a client talks to the VirtualBox core
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * using the XPCOM framework.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * However, if you want to write a real application, it is highly recommended
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * to use our MS COM XPCOM Glue library and helper C++ classes. This way, you
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * will get at least the following benefits:
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * a) better portability: both the MS COM (used on Windows) and XPCOM (used
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * everywhere else) VirtualBox client application from the same source code
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * (including common smart C++ templates for automatic interface pointer
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * reference counter and string data management);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * b) simpler XPCOM initialization and shutdown (only a signle method call
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * that does everything right).
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Currently, there is no separate sample program that uses the VirtualBox MS
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * COM XPCOM Glue library. Please refer to the sources of stock VirtualBox
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * applications such as the VirtualBox GUI frontend or the VBoxManage command
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * line frontend.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * RUNNING THIS SAMPLE PROGRAM
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * ---------------------------
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * This sample program needs to know where the VirtualBox core files reside
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * and where to search for VirtualBox shared libraries. Therefore, you need to
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * use the following (or similar) command to execute it:
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * $ env VBOX_XPCOM_HOME=../../.. LD_LIBRARY_PATH=../../.. ./tstVBoxAPILinux
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * The above command assumes that VBoxRT.so, VBoxXPCOM.so and others reside in
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * the directory ../../..
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Include the XPCOM headers
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * VirtualBox XPCOM interface. This header is generated
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * from IDL which in turn is generated from a custom XML format.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Display all registered VMs on the screen with some information about each
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * @param virtualBox VirtualBox instance object.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("----------------------------------------------------\n");
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Get the list of all registered VMs
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->GetMachines(&machineCnt, &machines);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Iterate through the collection
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan for (PRUint32 i = 0; i < machineCnt; ++ i)
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan machine->GetName(getter_Copies(machineName));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan char *machineNameAscii = ToNewCString(machineName);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan const char *uuidString = ToNewCString(iid);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan machine->GetSettingsFilePath(getter_Copies(configFile));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan char *configFileAscii = ToNewCString(configFile);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("\tConfig file: %s\n", configFileAscii);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("\tMemory size: %uMB\n", memorySize);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan machine->GetOSTypeId(getter_Copies(typeId));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan virtualBox->GetGuestOSType (typeId.get(), &osType);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan osType->GetDescription(getter_Copies(osName));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("\tGuest OS: %s\n\n", osNameAscii);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan /* don't forget to release the objects in the array... */
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("----------------------------------------------------\n\n");
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Create a sample VM
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * @param virtualBox VirtualBox instance object.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * First create a unnamed new VM. It will be unconfigured and not be saved
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * in the configuration until we explicitely choose to do so.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->CreateMachine(NS_LITERAL_STRING("A brand new name").get(),
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan nsnull, nsnull, nsnull, getter_AddRefs(machine));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not create machine! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Set some properties
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan /* alternative to illustrate the use of string classes */
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = machine->SetName(NS_ConvertUTF8toUTF16("A new name").get());
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Now a more advanced property -- the guest OS type. This is
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * an object by itself which has to be found first. Note that we
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * use the ID of the guest OS type here which is an internal
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * representation (you can find that by configuring the OS type of
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * a machine in the GUI and then looking at the <Guest ostype=""/>
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * setting in the XML file. It is also possible to get the OS type from
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * its description (win2k would be "Windows 2000") by getting the
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * guest OS type collection and enumerating it.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->GetGuestOSType(NS_LITERAL_STRING("win2k").get(),
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not find guest OS type! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan machine->SetOSTypeId (NS_LITERAL_STRING("win2k").get());
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Register the VM. Note that this call also saves the VM config
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * to disk. It is also possible to save the VM settings but not
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * register the VM.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Also note that due to current VirtualBox limitations, the machine
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * must be registered *before* we can attach hard disks to it.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->RegisterMachine(machine);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not register machine! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * In order to manipulate the registered machine, we must open a session
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * for that machine. Do it now.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = NS_GetComponentManager (getter_AddRefs (manager));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not get component manager! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = manager->CreateInstanceByContractID (NS_SESSION_CONTRACTID,
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error, could not instantiate Session object! rc=0x%x\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan machine->GetId(getter_Copies(machineUUID));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->OpenSession(session, machineUUID);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error, could not open session! rc=0x%x\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * After the machine is registered, the initial machine object becomes
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * immutable. In order to get a mutable machine object, we must query
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * it from the opened session object.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = session->GetMachine(getter_AddRefs(machine));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error, could not get sessioned machine! rc=0x%x\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Create a virtual harddisk
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->CreateHardDisk(NS_LITERAL_STRING("VDI").get(),
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan NS_LITERAL_STRING("TestHardDisk.vdi").get(),
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Failed creating a hard disk object! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * We have only created an object so far. No on disk representation exists
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * because none of its properties has been set so far. Let's continue creating
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * a dynamically expanding image.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = hardDisk->CreateBaseStorage(100, // size in megabytes
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan getter_AddRefs(progress)); // optional progress object
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Failed creating hard disk image! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Creating the image is done in the background because it can take quite
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * some time (at least fixed size images). We have to wait for its completion.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Here we wait forever (timeout -1) which is potentially dangerous.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan if (NS_FAILED(rc) || NS_FAILED(resultCode))
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not create hard disk! rc=%08X\n",
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Now that it's created, we can assign it to the VM. This is done
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * by UUID, so query that one fist. The UUID has been assigned automatically
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * when we've created the image.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = machine->AttachDevice(NS_LITERAL_STRING("IDE Controller").get(), // controller identifier
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan 0, // channel number on the controller
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan 0, // device number on the controller
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not attach hard disk! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * It's got a hard disk but that one is new and thus not bootable. Make it
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * boot from an ISO file. This requires some processing. First the ISO file
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * has to be registered and then mounted to the VM's DVD drive and selected
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * as the boot device.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = virtualBox->OpenDVDImage(NS_LITERAL_STRING("/home/vbox/isos/winnt4ger.iso").get(),
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan nsnull, /* NULL UUID, i.e. a new one will be created */
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not open CD image! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Now assign it to our VM
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = machine->MountMedium(NS_LITERAL_STRING("IDE Controller").get(), // controller identifier
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan 0, // device number on the controller
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not mount ISO image! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Last step: tell the VM to boot from the CD.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = machine->SetBootOrder (1, DeviceType::DVD);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Could not set boot device! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Save all changes we've just made.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Could not save machine settings! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * It is always important to close the open session when it becomes not
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * necessary any more.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan///////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Check that PRUnichar is equal in size to what compiler composes L""
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * strings from; otherwise NS_LITERAL_STRING macros won't work correctly
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * and we will get a meaningless SIGSEGV. This, of course, must be checked
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * at compile time in xpcom/string/nsTDependentString.h, but XPCOM lacks
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * compile-time assert macros and I'm not going to add them now.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan if (sizeof(PRUnichar) != sizeof(wchar_t))
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: sizeof(PRUnichar) {%lu} != sizeof(wchar_t) {%lu}!\n"
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan "Probably, you forgot the -fshort-wchar compiler option.\n",
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan (unsigned long) sizeof(PRUnichar),
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan (unsigned long) sizeof(wchar_t));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * This is the standard XPCOM init procedure.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * What we do is just follow the required steps to get an instance
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * of our main interface, which is IVirtualBox.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Note that we scope all nsCOMPtr variables in order to have all XPCOM
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * objects automatically released before we call NS_ShutdownXPCOM at the
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * end. This is an XPCOM requirement.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan nsCOMPtr<nsIServiceManager> serviceManager;
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = NS_InitXPCOM2(getter_AddRefs(serviceManager), nsnull, nsnull);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: XPCOM could not be initialized! rc=0x%x\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Register our components. This step is only necessary if this executable
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * implements XPCOM components itself which is not the case for this
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * simple example.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan nsCOMPtr<nsIComponentRegistrar> registrar = do_QueryInterface(serviceManager);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not query nsIComponentRegistrar interface!\n");
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Make sure the main event queue is created. This event queue is
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * responsible for dispatching incoming XPCOM IPC messages. The main
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * thread should run this event queue's loop during lengthy non-XPCOM
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * operations to ensure messages from the VirtualBox server and other
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * XPCOM IPC clients are processed. This use case doesn't perform such
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * operations so it doesn't run the event loop.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = NS_GetMainEventQ(getter_AddRefs (eventQ));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not get main event queue! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Now XPCOM is ready and we can start to do real work.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * IVirtualBox is the root interface of VirtualBox and will be
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * retrieved from the XPCOM component manager. We use the
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * XPCOM provided smart pointer nsCOMPtr for all objects because
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * that's very convenient and removes the need deal with reference
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * counting and freeing.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = NS_GetComponentManager (getter_AddRefs (manager));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error: could not get component manager! rc=%08X\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = manager->CreateInstanceByContractID (NS_VIRTUALBOX_CONTRACTID,
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf("Error, could not instantiate VirtualBox object! rc=0x%x\n", rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan ////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan ////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan ////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan ////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan ////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan ////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan /* this is enough to free the IVirtualBox instance -- smart pointers rule! */
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Process events that might have queued up in the XPCOM event
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * queue. If we don't process them, the server might hang.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Perform the standard XPCOM shutdown procedure.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan//////////////////////////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan//////////////////////////////////////////////////////////////////////////////////////////////////////
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Helper function to convert an nsID into a human readable string
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * @returns result string, allocated. Has to be freed using free()
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * @param guid Pointer to nsID that will be converted.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan snprintf(res, 39, "{%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x}",
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan guid->m0, (PRUint32)guid->m1, (PRUint32)guid->m2,
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan (PRUint32)guid->m3[0], (PRUint32)guid->m3[1], (PRUint32)guid->m3[2],
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan (PRUint32)guid->m3[3], (PRUint32)guid->m3[4], (PRUint32)guid->m3[5],
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan (PRUint32)guid->m3[6], (PRUint32)guid->m3[7]);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * Helper function to print XPCOM exception information set on the current
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * thread after a failed XPCOM method call. This function will also print
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan * extended VirtualBox error info if it is available.
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan es = do_GetService (NS_EXCEPTIONSERVICE_CONTRACTID, &rc);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = es->GetCurrentExceptionManager (getter_AddRefs (em));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan rc = em->GetCurrentException (getter_AddRefs (ex));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan /* got extended error info */
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf ("Extended error info (IVirtualBoxErrorInfo):\n");
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf (" resultCode=%08X\n", resultCode);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan info->GetComponent (getter_Copies (component));
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf (" component=%s\n", NS_ConvertUTF16toUTF8(component).get());
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf (" text=%s\n", NS_ConvertUTF16toUTF8(text).get());
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan /* got basic error info */
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf ("Basic error info (nsIException):\n");
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan printf (" resultCode=%08X\n", resultCode);
b494511a9cf72b1fc4eb13a0e593f55c624ab829Venki Rajagopalan /* reset the exception to NULL to indicate we've processed it */