Changeset 28689 in vbox for trunk/include

Timestamp:

Apr 24, 2010 6:23:57 PM (15 years ago)

Author:

vboxsync

Message:

XmlFileWrite::write: Added a fSafe argument for safe writing of the xml file. See method description for details.

File:

• trunk/include/iprt/cpp/xml.h (modified) (7 diffs)

trunk/include/iprt/cpp/xml.h

@@ -1 +1 @@
 /** @file
- * VirtualBox XML helper APIs.
+ * IPRT - XML Helper APIs.
  */
 
 /*
- * Copyright (C) 2007-2009 Sun Microsystems, Inc.
+ * Copyright (C) 2007-2010 Sun Microsystems, Inc.
  *
  * This file is part of VirtualBox Open Source Edition (OSE), as
@@ -28 +28 @@
  */
 
-#ifndef ___VBox_vboxxml_h
-#define ___VBox_vboxxml_h
+#ifndef ___iprt_xml_h
+#define ___iprt_xml_h
 
 #ifndef IN_RING3
@@ -288 +288 @@
      * @param aMode     File mode.
      * @param aFileName File name.
-     */
-    File(Mode aMode, const char *aFileName);
+     * @param aFlushIt  Whether to flush a writable file before closing it.
+     */
+    File(Mode aMode, const char *aFileName, bool aFlushIt = false);
 
     /**
@@ -308 +309 @@
      * @param aHandle   Open file handle.
      * @param aFileName File name (for reference).
-     */
-    File(RTFILE aHandle, const char *aFileName = NULL);
+     * @param aFlushIt  Whether to flush a writable file before closing it.
+     */
+    File(RTFILE aHandle, const char *aFileName = NULL, bool aFlushIt = false);
 
     /**
@@ -669 +671 @@
     ~XmlFileWriter();
 
-    void write(const char *pcszFilename);
+    /**
+     * Writes the XML document to the specified file.
+     *
+     * @param   pcszFilename    The name of the output file.
+     * @param   fSafe           If @c true, some extra safety precautions will be
+     *                          taken when writing the file:
+     *                              -# The file is written with a '-tmp' suffix.
+     *                              -# It is flushed to disk after writing.
+     *                              -# Any original file is renamed to '-prev'.
+     *                              -# The '-tmp' file is then renamed to the
+     *                                 specified name.
+     *                              -# The directory changes are flushed to disk.
+     */
+    void write(const char *pcszFilename, bool fSafe);
 
     static int WriteCallback(void *aCtxt, const char *aBuf, int aLen);
@@ -675 +690 @@
 
 private:
+    void writeInternal(const char *pcszFilename, bool fSafe);
+
     /* Obscure class data */
     struct Data;
@@ -688 +705 @@
 } // end namespace xml
 
-#endif /* ___VBox_vboxxml_h */
+#endif /* !___iprt_xml_h */