docs: Extracted sample code in a separate file, added stream loading sample prototype

git-svn-id: http://pugixml.googlecode.com/svn/trunk@534 99668b35-9821-0410-8761-19e4c4f06640

5 files changed, 249 insertions, 0 deletions

diff --git a/docs/samples/custom_memory_management.cpp b/docs/samples/custom_memory_management.cpp
new file mode 100644
index 0000000..01a2acf
--- /dev/null
+++ b/docs/samples/custom_memory_management.cpp
@@ -0,0 +1,25 @@
+#include "pugixml.hpp"

+

+#include <new>

+

+//[code_custom_memory_management_decl

+void* custom_allocate(size_t size)

+{

+	return new (std::nothrow) char[size];

+}

+

+void custom_deallocate(void* ptr)

+{

+	delete[] static_cast<char*>(ptr);

+}

+//]

+

+int main()

+{

+//[code_custom_memory_management_call

+	pugi::set_memory_management_functions(custom_allocate, custom_deallocate);

+//]

+

+	pugi::xml_document doc;

+	doc.load("<node/>");

+}

diff --git a/docs/samples/load_stream.cpp b/docs/samples/load_stream.cpp
new file mode 100644
index 0000000..4aba8bd
--- /dev/null
+++ b/docs/samples/load_stream.cpp
@@ -0,0 +1,68 @@
+#include "pugixml.hpp"

+

+#include <fstream>

+#include <iomanip>

+#include <iostream>

+

+void print_doc(const char* message, const pugi::xml_document& doc, const pugi::xml_parse_result& result)

+{

+	std::cout

+		<< message

+		<< "\t: load result '" << result.description() << "'"

+		<< ", first character of root name: U+" << std::hex << std::uppercase << std::setw(4) << std::setfill('0') << pugi::as_wide(doc.first_child().name())[0]

+		<< ", year: " << doc.first_child().first_child().first_child().child_value()

+		<< std::endl;

+}

+

+int main()

+{

+	pugi::xml_document doc;

+

+	{

+		std::ifstream stream("weekly-utf-8.xml");

+		pugi::xml_parse_result result = doc.load(stream);

+

+		// first character of root name: U+9031, year: 1997

+		print_doc("UTF8 file from narrow stream", doc, result);

+	}

+

+	{

+		std::ifstream stream("weekly-utf-16.xml");

+		pugi::xml_parse_result result = doc.load(stream);

+

+		// first character of root name: U+9031, year: 1997

+		print_doc("UTF16 file from narrow stream", doc, result);

+	}

+

+	{

+		// Since wide streams are treated as UTF-16/32 ones, you can't load the UTF-8 file from a wide stream

+		// directly if you have localized characters; you'll have to provide a UTF8 locale (there is no

+		// standard one; you can use utf8_codecvt_facet from Boost (WHAT?))

+		std::wifstream stream("weekly-utf-8.xml");

+		pugi::xml_parse_result result = doc.load(stream);

+

+		// first character of root name: U+00E9, year: 1997

+		print_doc("UTF8 file from wide stream", doc, result);

+	}

+

+	{

+		// Since wide streams are treated as UTF-16/32 ones, you can't load the UTF-16 file from a wide stream

+		// at all; you'll have to provide a UTF16 locale (WHAT??)

+		std::wifstream stream("weekly-utf-16.xml");

+		pugi::xml_parse_result result = doc.load(stream);

+

+		// first character of root name: U+0000, year:

+		print_doc("UTF16 file from wide stream", doc, result);

+	}

+

+	{

+		// Since encoding names are non-standard, you can't load the Shift-JIS (or any other non-ASCII) file

+		// from a wide stream portably; this code assumes Microsoft C Runtime Libraries (WHAT???)

+		std::wifstream stream("weekly-shift_jis.xml");

+		stream.imbue(std::locale(".932"));

+		pugi::xml_parse_result result = doc.load(stream);

+

+		// first character of root name: U+9031, year: 1997

+		print_doc("Shift-JIS file from wide stream", doc, result);

+	}

+}

diff --git a/docs/samples/weekly-shift_jis.xml b/docs/samples/weekly-shift_jis.xml
new file mode 100644
index 0000000..7421455
--- /dev/null
+++ b/docs/samples/weekly-shift_jis.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0" encoding="Shift_JIS"?>

+<!DOCTYPE 週報 SYSTEM "weekly-shift_jis.dtd">

+<!-- 週報サンプル -->

+<週報>

+  <年月週>

+    <年度>1997</年度>

+    <月度>1</月度>

+    <週>1</週>

+  </年月週>

+

+  <氏名>

+    <氏>山田</氏>

+    <名>太郎</名>

+  </氏名>

+

+  <業務報告リスト>

+    <業務報告>

+      <業務名>XMLエディターの作成</業務名>

+      <業務コード>X3355-23</業務コード>

+      <工数管理>

+        <見積もり工数>1600</見積もり工数>

+        <実績工数>320</実績工数>

+        <当月見積もり工数>160</当月見積もり工数>

+        <当月実績工数>24</当月実績工数>

+      </工数管理>

+      <予定項目リスト>

+        <予定項目>

+          <P>XMLエディターの基本仕様の作成</P>

+        </予定項目>

+      </予定項目リスト>

+      <実施事項リスト>

+        <実施事項>

+          <P>XMLエディターの基本仕様の作成</P>

+        </実施事項>

+        <実施事項>

+          <P>競合他社製品の機能調査</P>

+        </実施事項>

+      </実施事項リスト>

+      <上長への要請事項リスト>

+        <上長への要請事項>

+          <P>特になし</P>

+        </上長への要請事項>

+      </上長への要請事項リスト>

+      <問題点対策>

+        <P>XMLとは何かわからない。</P>

+      </問題点対策>

+    </業務報告>

+

+    <業務報告>

+      <業務名>検索エンジンの開発</業務名>

+      <業務コード>S8821-76</業務コード>

+      <工数管理>

+        <見積もり工数>120</見積もり工数>

+        <実績工数>6</実績工数>

+        <当月見積もり工数>32</当月見積もり工数>

+        <当月実績工数>2</当月実績工数>

+      </工数管理>

+      <予定項目リスト>

+        <予定項目>

+          <P><A href="http://www.goo.ne.jp">goo</A>の機能を調べてみる</P>

+        </予定項目>

+      </予定項目リスト>

+      <実施事項リスト>

+        <実施事項>

+          <P>更に、どういう検索エンジンがあるか調査する</P>

+        </実施事項>

+      </実施事項リスト>

+      <上長への要請事項リスト>

+        <上長への要請事項>

+          <P>開発をするのはめんどうなので、Yahoo!を買収して下さい。</P>

+        </上長への要請事項>

+      </上長への要請事項リスト>

+      <問題点対策>

+        <P>検索エンジンで車を走らせることができない。（要調査）</P>

+      </問題点対策>

+    </業務報告>

+  </業務報告リスト>

+</週報>

diff --git a/docs/samples/weekly-utf-16.xml b/docs/samples/weekly-utf-16.xml
new file mode 100644
index 0000000..6c8622a
--- /dev/null
+++ b/docs/samples/weekly-utf-16.xml
diff --git a/docs/samples/weekly-utf-8.xml b/docs/samples/weekly-utf-8.xml
new file mode 100644
index 0000000..497f572
--- /dev/null
+++ b/docs/samples/weekly-utf-8.xml
@@ -0,0 +1,78 @@
+<?xml version="1.0"?>

+<!DOCTYPE 騾ｱ蝣ｱ SYSTEM "weekly-utf-8.dtd">

+<!-- 騾ｱ蝣ｱ繧ｵ繝ｳ繝励Ν -->

+<騾ｱ蝣ｱ>

+  <蟷ｴ譛磯�ｱ>

+    <蟷ｴ蠎ｦ>1997</蟷ｴ蠎ｦ>

+    <譛亥ｺｦ>1</譛亥ｺｦ>

+    <騾ｱ>1</騾ｱ>

+  </蟷ｴ譛磯�ｱ>

+

+  <豌丞錐>

+    <豌�>螻ｱ逕ｰ</豌�>

+    <蜷�>螟ｪ驛�</蜷�>

+  </豌丞錐>

+

+  <讌ｭ蜍吝�ｱ蜻翫Μ繧ｹ繝�>

+    <讌ｭ蜍吝�ｱ蜻�>

+      <讌ｭ蜍吝錐>XML繧ｨ繝�繧｣繧ｿ繝ｼ縺ｮ菴懈��</讌ｭ蜍吝錐>

+      <讌ｭ蜍吶さ繝ｼ繝�>X3355-23</讌ｭ蜍吶さ繝ｼ繝�>

+      <蟾･謨ｰ邂｡逅�>

+        <隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>1600</隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>

+        <螳溽ｸｾ蟾･謨ｰ>320</螳溽ｸｾ蟾･謨ｰ>

+        <蠖捺怦隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>160</蠖捺怦隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>

+        <蠖捺怦螳溽ｸｾ蟾･謨ｰ>24</蠖捺怦螳溽ｸｾ蟾･謨ｰ>

+      </蟾･謨ｰ邂｡逅�>

+      <莠亥ｮ夐��逶ｮ繝ｪ繧ｹ繝�>

+        <莠亥ｮ夐��逶ｮ>

+          <P>XML繧ｨ繝�繧｣繧ｿ繝ｼ縺ｮ蝓ｺ譛ｬ莉墓ｧ倥�ｮ菴懈��</P>

+        </莠亥ｮ夐��逶ｮ>

+      </莠亥ｮ夐��逶ｮ繝ｪ繧ｹ繝�>

+      <螳滓命莠矩��繝ｪ繧ｹ繝�>

+        <螳滓命莠矩��>

+          <P>XML繧ｨ繝�繧｣繧ｿ繝ｼ縺ｮ蝓ｺ譛ｬ莉墓ｧ倥�ｮ菴懈��</P>

+        </螳滓命莠矩��>

+        <螳滓命莠矩��>

+          <P>遶ｶ蜷井ｻ也､ｾ陬ｽ蜩√�ｮ讖溯�ｽ隱ｿ譟ｻ</P>

+        </螳滓命莠矩��>

+      </螳滓命莠矩��繝ｪ繧ｹ繝�>

+      <荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��繝ｪ繧ｹ繝�>

+        <荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��>

+          <P>迚ｹ縺ｫ縺ｪ縺�</P>

+        </荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��>

+      </荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��繝ｪ繧ｹ繝�>

+      <蝠城｡檎せ蟇ｾ遲�>

+        <P>XML縺ｨ縺ｯ菴輔°繧上°繧峨↑縺�縲�</P>

+      </蝠城｡檎せ蟇ｾ遲�>

+    </讌ｭ蜍吝�ｱ蜻�>

+

+    <讌ｭ蜍吝�ｱ蜻�>

+      <讌ｭ蜍吝錐>讀懃ｴ｢繧ｨ繝ｳ繧ｸ繝ｳ縺ｮ髢狗匱</讌ｭ蜍吝錐>

+      <讌ｭ蜍吶さ繝ｼ繝�>S8821-76</讌ｭ蜍吶さ繝ｼ繝�>

+      <蟾･謨ｰ邂｡逅�>

+        <隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>120</隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>

+        <螳溽ｸｾ蟾･謨ｰ>6</螳溽ｸｾ蟾･謨ｰ>

+        <蠖捺怦隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>32</蠖捺怦隕狗ｩ阪ｂ繧雁ｷ･謨ｰ>

+        <蠖捺怦螳溽ｸｾ蟾･謨ｰ>2</蠖捺怦螳溽ｸｾ蟾･謨ｰ>

+      </蟾･謨ｰ邂｡逅�>

+      <莠亥ｮ夐��逶ｮ繝ｪ繧ｹ繝�>

+        <莠亥ｮ夐��逶ｮ>

+          <P><A href="http://www.goo.ne.jp">goo</A>縺ｮ讖溯�ｽ繧定ｪｿ縺ｹ縺ｦ縺ｿ繧�</P>

+        </莠亥ｮ夐��逶ｮ>

+      </莠亥ｮ夐��逶ｮ繝ｪ繧ｹ繝�>

+      <螳滓命莠矩��繝ｪ繧ｹ繝�>

+        <螳滓命莠矩��>

+          <P>譖ｴ縺ｫ縲√←縺�縺�縺�讀懃ｴ｢繧ｨ繝ｳ繧ｸ繝ｳ縺後≠繧九°隱ｿ譟ｻ縺吶ｋ</P>

+        </螳滓命莠矩��>

+      </螳滓命莠矩��繝ｪ繧ｹ繝�>

+      <荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��繝ｪ繧ｹ繝�>

+        <荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��>

+          <P>髢狗匱繧偵☆繧九�ｮ縺ｯ繧√ｓ縺ｩ縺�縺ｪ縺ｮ縺ｧ縲〆ahoo!繧定ｲｷ蜿弱＠縺ｦ荳九＆縺�縲�</P>

+        </荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��>

+      </荳企聞縺ｸ縺ｮ隕∬ｫ倶ｺ矩��繝ｪ繧ｹ繝�>

+      <蝠城｡檎せ蟇ｾ遲�>

+        <P>讀懃ｴ｢繧ｨ繝ｳ繧ｸ繝ｳ縺ｧ霆翫ｒ襍ｰ繧峨○繧九％縺ｨ縺後〒縺阪↑縺�縲ゑｼ郁ｦ∬ｪｿ譟ｻ�ｼ�</P>

+      </蝠城｡檎せ蟇ｾ遲�>

+    </讌ｭ蜍吝�ｱ蜻�>

+  </讌ｭ蜍吝�ｱ蜻翫Μ繧ｹ繝�>

+</騾ｱ蝣ｱ>