Installation

The distribution contains library source, documentation (the manual you're reading now and the quick start guide) and some code examples. After downloading the distribution, install pugixml by extracting all files from the compressed - archive. + archive. The files have different line endings depending on the archive + format - .zip archive has Windows line endings, .tar.gz archive has Unix + line endings. Otherwise the files in both archives are identical.

Building pugixml as a part of another static library/executable

- The easiest way to build pugixml is to compile two source files, pugixml.cpp and - pugixpath.cpp, along with the existing library/executable. This process - depends on the method of building your application; for example, if you're - using Microsoft Visual Studio^[1], Apple Xcode, Code::Blocks or any other IDE, - just add pugixml.cpp and pugixpath.cpp to one of your projects. + The easiest way to build pugixml is to compile the source file, pugixml.cpp, + along with the existing library/executable. This process depends on the + method of building your application; for example, if you're using Microsoft + Visual Studio^[1], Apple Xcode, Code::Blocks or any other IDE, just add pugixml.cpp to + one of your projects.

If you're using Microsoft Visual Studio and the project has precompiled headers turned on, you'll see the following error messages:

pugixpath.cpp(3477) : fatal error C1010: unexpected end of file while looking for precompiled header. Did you forget to add '#include "stdafx.h"' to your source?

pugixml.cpp(3477) : fatal error C1010: unexpected end of file while looking for precompiled header. Did you forget to add '#include "stdafx.h"' to your source?

- The correct way to resolve this is to disable precompiled headers for pugixml.cpp and - pugixpath.cpp; you have to set "Create/Use Precompiled Header" - option (Properties dialog -> C/C++ -> Precompiled Headers -> Create/Use - Precompiled Header) to "Not Using Precompiled Headers". You'll - have to do it for both pugixml.cpp and pugixpath.cpp, for all project configurations/platforms - (you can select Configuration "All Configurations" and Platform - "All Platforms" before editing the option): + The correct way to resolve this is to disable precompiled headers for pugixml.cpp; + you have to set "Create/Use Precompiled Header" option (Properties + dialog -> C/C++ -> Precompiled Headers -> Create/Use Precompiled + Header) to "Not Using Precompiled Headers". You'll have to do + it for all project configurations/platforms (you can select Configuration + "All Configurations" and Platform "All Platforms" before + editing the option):

@@ -251,7 +245,7 @@ process does not differ from building any other library as DLL (adding -shared to compilation flags should suffice); if you're using MSVC-based toolchain, you'll have to explicitly mark exported symbols with a declspec - attribute. You can do it by defining PUGIXML_API + attribute. You can do it by defining PUGIXML_API macro, i.e. via pugiconfig.hpp:

#ifdef _DLL
@@ -260,6 +254,20 @@
 #define PUGIXML_API __declspec(dllimport)
 #endif

+ + + + + +

Caution

+ If you're using STL-related functions, you should use the shared runtime + library to ensure that a single heap is used for STL allocations in your + application and in pugixml; in MSVC, this means selecting the 'Multithreaded + DLL' or 'Multithreaded Debug DLL' to 'Runtime library' property (/MD + or /MDd linker switch). You should also make sure that your runtime library + choice is consistent between different projects. +

@@ -270,13 +278,13 @@ pugixml uses several defines to control the compilation process. There are two ways to define them: either put the needed definitions to `pugiconfig.hpp` (it has some examples that are commented out) or provide them via compiler - command-line. Define consistency is important, i.e. the definitions should - match in all source files that include `pugixml.hpp` (including pugixml sources) - throughout the application. Adding defines to `pugiconfig.hpp` lets you guarantee - this, unless your macro definition is wrapped in preprocessor `#if`/`#ifdef` - directive and this directive is not consistent. `pugiconfig.hpp` will never - contain anything but comments, which means that when upgrading to new version, - you can safely leave your modified version intact. + command-line. Consistency is important: the definitions should match in + all source files that include `pugixml.hpp` (including pugixml sources) throughout + the application. Adding defines to `pugiconfig.hpp` lets you guarantee this, + unless your macro definition is wrapped in preprocessor `#if`/`#ifdef` directive and this directive + is not consistent. `pugiconfig.hpp` will never contain anything but comments, + which means that when upgrading to a new version, you can safely leave + your modified version intact.

`PUGIXML_WCHAR_MODE` define toggles @@ -289,10 +297,9 @@

`PUGIXML_NO_XPATH` define disables XPath. - Both XPath interfaces and XPath implementation are excluded from compilation; - you can still compile the file `pugixpath.cpp` (it will result in an empty - translation unit). This option is provided in case you do not need XPath - functionality and need to save code space. + Both XPath interfaces and XPath implementation are excluded from compilation. + This option is provided in case you do not need XPath functionality and + need to save code space.

`PUGIXML_NO_STL` define disables use of @@ -301,33 +308,11 @@ provided in case your target platform does not have a standard-compliant STL implementation.
-
- - - - - -
Note
- As of version 0.9, STL is used in XPath implementation; therefore, XPath - is also disabled if this macro is defined. This will change in version - 1.0. -

`PUGIXML_NO_EXCEPTIONS` define disables use of exceptions in pugixml. This option is provided in case your target - platform does not have exception handling capabilities + platform does not have exception handling capabilities.
-
- - - - - -
Note
- As of version 0.9, exceptions are only - used in XPath implementation; therefore, XPath is also disabled if this - macro is defined. This will change in version 1.0. -

`PUGIXML_API`, `PUGIXML_CLASS` and `PUGIXML_FUNCTION` defines let you @@ -414,8 +399,8 @@

^[1]All trademarks used are properties - of their respective owners.

^[1]All trademarks used are properties of their respective + owners.

@@ -427,7 +412,8 @@

pugixml 0.9 manual | +

+pugixml 1.0 manual | Overview | Installation | Document: -- cgit v1.2.3