Localized DOM

doc/dom.zh-cn.md

+# DOM
+
+文档对象模型（Document Object Model, DOM）是一种罝于内存中的JSON表示方式，以供查询及操作。我们己于[教程](doc/tutorial.md)中介绍了DOM的基本用法，本节将讲述一些细节及高级用法。
+
+[TOC]
+
+# 模板 {#Template}
+
+教程中使用了`Value`和`Document`类型。与`std::string`相似，这些类型其实是两个模板类的`typedef`：
+
+~~~~~~~~~~cpp
+namespace rapidjson {
+
+template <typename Encoding, typename Allocator = MemoryPoolAllocator<> >
+class GenericValue {
+    // ...
+};
+
+template <typename Encoding, typename Allocator = MemoryPoolAllocator<> >
+class GenericDocument : public GenericValue<Encoding, Allocator> {
+    // ...
+};
+
+typedef GenericValue<UTF8<> > Value;
+typedef GenericDocument<UTF8<> > Document;
+
+} // namespace rapidjson
+~~~~~~~~~~
+
+使用者可以自定义这些模板参数。
+
+## 编码 {#Encoding}
+
+`Encoding`参数指明在内存中的JSON String使用哪种编码。可行的选项有`UTF8`、`UTF16`、`UTF32`。要注意这3个类型其实也是模板类。`UTF8<>`等同`UTF8<char>`，这代表它使用`char`来存储字符串。更多细节可以参考[编码](encoding.md)。
+
+这里是一个例子。假设一个Windows应用软件希望查询存储于JSON中的本地化字符串。Windows中含Unicode的函数使用UTF-16（宽字符）编码。无论JSON文件使用哪种编码，我们都可以把字符串以UTF-16形式存储在内存。
+
+~~~~~~~~~~cpp
+using namespace rapidjson;
+
+typedef GenericDocument<UTF16<> > WDocument;
+typedef GenericValue<UTF16<> > WValue;
+
+FILE* fp = fopen("localization.json", "rb"); // 非Windows平台使用"r"
+
+char readBuffer[256];
+FileReadStream bis(fp, readBuffer, sizeof(readBuffer));
+
+AutoUTFInputStream<unsigned, FileReadStream> eis(bis);  // 包装bis成eis
+
+WDocument d;
+d.ParseStream<0, AutoUTF<unsigned> >(eis);
+
+const WValue locale(L"ja"); // Japanese
+
+MessageBoxW(hWnd, d[locale].GetString(), L"Test", MB_OK);
+~~~~~~~~~~
+
+## 分配器 {#Allocator}
+
+`Allocator`定义当`Document`/`Value`分配或释放内存时使用那个分配类。`Document`拥有或引用到一个`Allocator`实例。而为了节省内存，`Value`没有这么做。
+
+`GenericDocument`的缺省分配器是`MemoryPoolAllocator`。此分配器实际上会顺序地分配内存，并且不能逐一释放。当要解析一个JSON并生成DOM，这种分配器是非常合适的。
+
+RapidJSON还提供另一个分配器`CrtAllocator`，当中CRT是C运行库（C RunTime library）的缩写。此分配器简单地读用标准的`malloc()`/`realloc()`/`free()`。当我们需要许多增减操作，这种分配器会更为适合。然而这种分配器远远比`MemoryPoolAllocator`低效。
+
+# 解析 {#Parsing}
+
+`Document`提供几个解析函数。以下的(1)是根本的函数，其他都是调用(1)的协助函数。
+
+~~~~~~~~~~cpp
+using namespace rapidjson;
+
+// (1) 根本
+template <unsigned parseFlags, typename SourceEncoding, typename InputStream>
+GenericDocument& GenericDocument::ParseStream(InputStream& is);
+
+// (2) 使用流的编码
+template <unsigned parseFlags, typename InputStream>
+GenericDocument& GenericDocument::ParseStream(InputStream& is);
+
+// (3) 使用缺省标志
+template <typename InputStream>
+GenericDocument& GenericDocument::ParseStream(InputStream& is);
+
+// (4) 原位解析
+template <unsigned parseFlags, typename SourceEncoding>
+GenericDocument& GenericDocument::ParseInsitu(Ch* str);
+
+// (5) 原位解析，使用Document的编码
+template <unsigned parseFlags>
+GenericDocument& GenericDocument::ParseInsitu(Ch* str);
+
+// (6) 原位解析，使用缺省标志
+GenericDocument& GenericDocument::ParseInsitu(Ch* str);
+
+// (7) 正常解析一个字符串
+template <unsigned parseFlags, typename SourceEncoding>
+GenericDocument& GenericDocument::Parse(const Ch* str);
+
+// (8) 正常解析一个字符串，使用Document的编码
+template <unsigned parseFlags>
+GenericDocument& GenericDocument::Parse(const Ch* str);
+
+// (9) 正常解析一个字符串，使用缺省标志
+GenericDocument& GenericDocument::Parse(const Ch* str);
+~~~~~~~~~~
+
+[教程](tutorial.md)中的例使用(9)去正常解析字符串。而[流](stream.md)的例子使用前3个函数。我们将稍后介绍原位（*In situ*） 解析。
+
+`parseFlags`是以下位标置的组合：
+
+解析位标志                    | 意义
+------------------------------|-----------------------------------
+`kParseNoFlags`               | 没有任何标志。
+`kParseDefaultFlags`          | 缺省的解析选项。它等于`RAPIDJSON_PARSE_DEFAULT_FLAGS`宏，此宏定义为`kParseNoFlags`。
+`kParseInsituFlag`            | 原位（破坏性）解析。
+`kParseValidateEncodingFlag`  | 校验JSON字符串的编码。
+`kParseIterativeFlag`         | 迭代式（调用堆栈大小为常数复杂度）解析。
+`kParseStopWhenDoneFlag`      | 当从流解析了一个完整的JSON根节点之后，停止继续处理余下的流。当使用了此标志，解析器便不会产生`kParseErrorDocumentRootNotSingular`错误。可使用本标志去解析同一个流里的多个JSON。
+`kParseFullPrecisionFlag`     | 使用完整的精确度去解析数字（较慢）。如不设置此标节，则会使用正常的精确度（较快）。正常精确度会有最多3个[ULP](http://en.wikipedia.org/wiki/Unit_in_the_last_place)的误差。
+
+由于使用了非类型模板参数，而不是函数参数，C++编译器能为个别组合生成代码，以改善性能及减少代码尺寸（当只用单种特化）。缺点是需要在编译期决定标志。
+
+`SourceEncoding`参数定义流使用了什么编码。这与`Document`的`Encoding`不相同。细节可参考[转码和校验](#TranscodingAndValidation)一节。
+
+此外`InputStream`是输入流的类型。
+
+## 解析错误 {#ParseError}
+
+当解析过程顺利完成，`Document`便会含有解析结果。当过程出现错误，原来的DOM会*维持不便*。可使用`bool HasParseError()`、`ParseErrorCode GetParseError()`及`size_t GetParseOffet()`获取解析的错误状态。
+
+解析错误代号                                | 描述
+--------------------------------------------|---------------------------------------------------
+`kParseErrorNone`                           | 无错误。
+`kParseErrorDocumentEmpty`                  | 文档是空的。
+`kParseErrorDocumentRootNotSingular`        | 文档的根后面不能有其它值。
+`kParseErrorValueInvalid`                   | 不合法的值。
+`kParseErrorObjectMissName`                 | Object成员缺少名字。
+`kParseErrorObjectMissColon`                | Object成员名字后缺少冒号。
+`kParseErrorObjectMissCommaOrCurlyBracket`  | Object成员后缺少逗号或`}`。
+`kParseErrorArrayMissCommaOrSquareBracket`  | Array元素后缺少逗号或`]` 。
+`kParseErrorStringUnicodeEscapeInvalidHex`  | String中的`\\u`转义符后含非十六进位数字。
+`kParseErrorStringUnicodeSurrogateInvalid`  | String中的代理对（surrogate pair）不合法。
+`kParseErrorStringEscapeInvalid`            | String含非法转义字符。
+`kParseErrorStringMissQuotationMark`        | String缺少关闭引号。
+`kParseErrorStringInvalidEncoding`          | String含非法编码。
+`kParseErrorNumberTooBig`                   | Number的值太大，不能存储于`double`。
+`kParseErrorNumberMissFraction`             | Number缺少了小数部分。
+`kParseErrorNumberMissExponent`             | Number缺少了指数。
+
+错误的偏移量定义为从流开始至错误处的字符数量。目前RapidJSON不记录错误行号。
+
+要取得错误讯息，RapidJSON在`rapidjson/error/en.h`中提供了英文错误讯息。使用者可以修改它用于其他语言环境，或使用一个自定义的本地化系统。
+
+以下是一个处理错误的例子。
+
+~~~~~~~~~~cpp
+// TODO: example
+~~~~~~~~~~
+
+## 原位解析 {#InSituParsing}
+
+根据[维基百科](http://en.wikipedia.org/wiki/In_situ):
+
+> *In situ* ... is a Latin phrase that translates literally to "on site" or "in position". It means "locally", "on site", "on the premises" or "in place" to describe an event where it takes place, and is used in many different contexts.
+> ...
+> (In computer science) An algorithm is said to be an in situ algorithm, or in-place algorithm, if the extra amount of memory required to execute the algorithm is O(1), that is, does not exceed a constant no matter how large the input. For example, heapsort is an in situ sorting algorithm.
+
+> 翻译：*In situ*……是一个拉丁文片语，字面上的意思是指「现场」、「在位置」。在许多不同语境中，它描述一个事件发生的位置，意指「本地」、「现场」、「在处所」、「就位」。
+> ……
+> （在计算机科学中）一个算法若称为原位算法，或在位算法，是指执行该算法所需的额外内存空间是O(1)的，换句话说，无论输入大小都只需要常数空间。例如，堆排序是一个原位排序算法。
+
+在正常的解析过程中，对JSON string解码并复制至其他缓冲区是一个很大的开销。原位解析（*in situ* parsing）把这些JSON string直接解码于它原来存储的地方。由于解码后的string长度总是短于或等于原来储存于JSON的string，所以这是可行的。在这个语境下，对JSON string进行解码是指处理转义符，如`"\n"`、`"\u1234"`等，以及在string末端加入空终止符号(`'\0'`)。
+
+以下的图比较正常及原位解析。JSON string值包含指向解码后的字符串。
+
+![正常解析](diagram/normalparsing.png)
+
+在正常解析中，解码后的字符串被复制至全新分配的缓冲区中。`"\\n"`（2个字符）被解码成`"\n"`（1个字符）。`"\\u0073"`（6个字符）被解码成`"s"`（1个字符）。
+
+![原位解析](diagram/insituparsing.png)
+
+原位解析直接修改了原来的JSON。图中高亮了被更新的字符。若JSON string不含转义符，例如`"msg"`，那么解析过程仅仅是以空字符代替结束双引号。
+
+由于原位解析修改了输入，其解析API需要`char*`而非`const char*`。
+
+~~~~~~~~~~cpp
+// 把整个文件读入buffer
+FILE* fp = fopen("test.json", "r");
+fseek(fp, 0, SEEK_END);
+size_t filesize = (size_t)ftell(fp);
+fseek(fp, 0, SEEK_SET);
+char* buffer = (char*)malloc(filesize + 1);
+size_t readLength = fread(buffer, 1, filesize, fp);
+buffer[readLength] = '\0';
+fclose(fp);
+
+// 原位解析buffer至d，buffer内容会被修改。
+Document d;
+d.ParseInsitu(buffer);
+
+// 在此查询、修改DOM……
+
+free(buffer);
+// 注意：在这个位置，d可能含有指向已被释放的buffer的悬空指针
+~~~~~~~~~~
+
+JSON string会被打上const-string的标志。但它们可能并非真正的「常数」。它的生命周期取决于存储JSON的缓冲区。
+
+原位解析把分配开销及内存复制减至最小。通常这样做能改善缓存一致性，而这对现代计算机来说是一个重要的性能因素。
+
+原位解析有以下限制：
+
+1. 整个JSON须存储在内存之中。
+2. 流的来源缓码与文档的目标编码必须相同。
+3. 需要保留缓冲区，直至文档不再被使用。
+4. 若DOM需要在解析后被长期使用，而DOM内只有很少JSON string，保留缓冲区可能造成内存浪费。
+
+原位解析最适合用于短期的、用完即弃的JSON。实际应用中，这些场合是非常普遍的，例如反序列化JSON至C++对象、处理以JSON表示的web请求等。
+
+## 转码与校验 {#TranscodingAndValidation}
+
+RapidJSON内部支持不同Unicode格式（正式的术语是UCS变换格式）间的转换。在DOM解析时，流的来源编码与DOM的编码可以不同。例如，来源流可能含有UTF-8的JSON，而DOM则使用UTF-16编码。在[EncodedInputStream](doc/stream.md#EncodedInputStream)一节里有一个例子。
+
+当从DOM输出一个JSON至输出流之时，也可以使用转码功能。在[EncodedOutputStream](stream.md#EncodedOutputStream)一节里有一个例子。
+
+在转码过程中，会把来源string解码成Unicode码点，然后把码点编码成目标格式。在解码时，它会校验来源string的字节序列是否合法。若遇上非合法序列，解析器会停止并返回`kParseErrorStringInvalidEncoding`错误。
+
+当来源编码与DOM的编码相同，解析器缺省地*不会*校验序列。使用者可开启`kParseValidateEncodingFlag`去强制校验。
+
+# 技巧 {#Techniques}
+
+这里讨论一些DOM API的使用技巧。
+
+## 把DOM作为SAX事件发表者
+
+在RapidJSON中，利用`Writer`把DOM生成JSON的做法，看来有点奇怪。
+
+~~~~~~~~~~cpp
+// ...
+Writer<StringBuffer> writer(buffer);
+d.Accept(writer);
+~~~~~~~~~~
+
+实际上，`Value::Accept()`是负责发布该值相关的SAX事件至处理器的。通过这个设计，`Value`及`Writer`解除了偶合。`Value`可生成SAX事件，而`Writer`则可以处理这些事件。
+
+使用者可以创建自定义的处理器，去把DOM转换成其它格式。例如，一个把DOM转换成XML的处理器。
+
+~~~~~~~~~~cpp
+// TODO: example
+~~~~~~~~~~
+
+要知道更多关于SAX事件与处理器，可参阅[SAX](doc/sax.md)。
+
+## 使用者缓冲区{ #UserBuffer}
+
+许多应用软件可能需要尽量减少内存分配。
+
+`MemoryPoolAllocator`可以帮助这方面，它容许使用者提供一个缓冲区。该缓冲区可能置于程序堆栈，或是一个静态分配的「草稿缓冲区（scratch buffer）」（一个静态／全局的数组），用于储存临时数据。
+
+`MemoryPoolAllocator`会先用使用者缓冲区去解决分配请求。当使用者缓冲区用完，就会从基础分配器（缺省为`CrtAllocator`）分配一块内存。
+
+以下是使用堆栈内存的例子，第一个分配器用于存储值，第二个用于解析时的临时缓冲。
+
+~~~~~~~~~~cpp
+typedef GenericDocument<UTF8<>, MemoryPoolAllocator<>, MemoryPoolAllocator<>> DocumentType;
+char valueBuffer[4096];
+char parseBuffer[1024];
+MemoryPoolAllocator<> valueAllocator(valueBuffer, sizeof(valueBuffer));
+MemoryPoolAllocator<> parseAllocator(parseBuffer, sizeof(parseBuffer));
+DocumentType d(&valueAllocator, sizeof(parseBuffer), &parseAllocator);
+d.Parse(json);
+~~~~~~~~~~
+
+若解析时分配总量少于4096+1024字节时，这段代码不会造成任何堆内存分配（经`new`或`malloc()`）。
+
+使用者可以通过`MemoryPoolAllocator::Size()`查询当前已分的内存大小。那么使用者可以拟定使用者缓冲区的合适大小。