More documentation, small improvements

git-svn-id: https://svn.kapsi.fi/jpa/nanopb@955 e3a754e5-d11d-0410-8d38-ebb782a927b9

1 files changed, 112 insertions, 27 deletions

diff --git a/docs/concepts.rst b/docs/concepts.rst
index 30daed01..f2475aec 100644
--- a/docs/concepts.rst
+++ b/docs/concepts.rst
@@ -4,24 +4,9 @@ Nanopb: Basic concepts
 
 The things outlined here are common to both the encoder and the decoder part.
 
-Return values and error handling
-================================
-
-Most functions in nanopb return *bool*. *True* means success, *false* means failure.
-
-Because code size is of the essence, nanopb doesn't give any information about the cause of the error. However, there are few possible sources of errors:
-
-1) Running out of memory. Because everything is allocated from the stack, nanopb can't detect this itself. Encoding or decoding the same type of a message always takes the same amount of stack space. Therefore, if it works once, it works always.
-2) Invalid field description. These are usually stored as constants, so if it works under the debugger, it always does.
-3) IO errors in your own stream callbacks. Because encoding/decoding stops at the first error, you can overwrite the *state* field in the struct and store your own error code there.
-4) Errors in your callback functions. You can use the state field in the callback structure.
-5) Exceeding the max_size or bytes_left of a stream.
-6) Exceeding the max_size of a string or array field
-7) Invalid protocol buffers binary message. It's not like you could recover from it anyway, so a simple failure should be enough.
+.. sectnum::
 
-In my opinion, it is enough that 1) and 2) can be resolved using a debugger.
-
-However, you may be interested which of the remaining conditions caused the error. For 3) and 4), you can check the state. If you have to detect 5) and 6), you should convert the fields to callback type. Any remaining problem is of type 7).
+.. contents::
 
 Streams
 =======
@@ -33,7 +18,7 @@ There are a few generic rules for callback functions:
 
 #) Return false on IO errors. The encoding or decoding process will abort immediately.
 #) Use state to store your own data, such as a file descriptor.
-#) *bytes_written* and *bytes_left* are updated by *pb_write* and *pb_read*. Don't touch them.
+#) *bytes_written* and *bytes_left* are updated by pb_write and pb_read.
 #) Your callback may be used with substreams. In this case *bytes_left*, *bytes_written* and *max_size* have smaller values than the original stream. Don't use these values to calculate pointers.
 
 Output streams
@@ -51,9 +36,7 @@ Output streams
 
 The *callback* for output stream may be NULL, in which case the stream simply counts the number of bytes written. In this case, *max_size* is ignored.
 
-Otherwise, if *bytes_written* + bytes_to_be_written is larger than *max_size*, *pb_write* returns false before doing anything else. If you don't want to limit the size of the stream, pass SIZE_MAX.
-
-Most commonly you want to initialize *bytes_written* to 0. It doesn't matter to the library, though.
+Otherwise, if *bytes_written* + bytes_to_be_written is larger than *max_size*, pb_write returns false before doing anything else. If you don't want to limit the size of the stream, pass SIZE_MAX.
  
 **Example 1:**
 
@@ -68,21 +51,22 @@ This is the way to get the size of the message without storing it anywhere::
 
 Writing to stdout::
 
- bool streamcallback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
+ bool callback(pb_ostream_t *stream, const uint8_t *buf, size_t count)
  {
     FILE *file = (FILE*) stream->state;
     return fwrite(buf, 1, count, file) == count;
  }
  
- pb_ostream_t stdoutstream = {&streamcallback, stdout, SIZE_MAX, 0};
+ pb_ostream_t stdoutstream = {&callback, stdout, SIZE_MAX, 0};
 
 Input streams
 -------------
 For input streams, there are a few extra rules:
+
 #) If buf is NULL, read from stream but don't store the data. This is used to skip unknown input.
 #) You don't need to know the length of the message in advance. After getting EOF error when reading, set bytes_left to 0 and return false. Pb_decode will detect this and if the EOF was in a proper position, it will return true.
 
-::
+Here is the structure::
 
  struct _pb_istream_t
  {
@@ -91,8 +75,109 @@ For input streams, there are a few extra rules:
     size_t bytes_left;
  };
 
-The *callback* must always be a function pointer.
+The *callback* must always be a function pointer. *Bytes_left* is an upper limit on the number of bytes that will be read. You can use SIZE_MAX if your callback handles EOF as described above.
+
+**Example:**
+
+This function binds an input stream to stdin:
+
+:: 
+
+ bool callback(pb_istream_t *stream, uint8_t *buf, size_t count)
+ {
+    FILE *file = (FILE*)stream->state;
+    bool status;
+    
+    if (buf == NULL)
+    {
+        while (count-- && fgetc(file) != EOF);
+        return count == 0;
+    }
+    
+    status = (fread(buf, 1, count, file) == count);
+    
+    if (feof(file))
+        stream->bytes_left = 0;
+    
+    return status;
+ }
+ 
+ pb_istream_t stdinstream = {&callback, stdin, SIZE_MAX};
+
+Data types
+==========
+
+Most Protocol Buffers datatypes have directly corresponding C datatypes, such as int32 is int32_t, float is float and bool is bool. However, the variable-length datatypes are more complex:
+
+1) Strings, bytes and repeated fields of any type map to callback functions by default.
+2) If there is a special option *(nanopb).max_size* specified in the .proto file, string maps to null-terminated char array and bytes map to a structure containing a char array and a size field.
+3) If there is a special option *(nanopb).max_count* specified on a repeated field, it maps to an array of whatever type is being repeated. Another field will be created for the actual number of entries stored.
+
+=============================================================================== =======================
+      field in .proto                                                           autogenerated in .h
+=============================================================================== =======================
+required string name = 1;                                                       pb_callback_t name;
+required string name = 1 [(nanopb).max_size = 40];                              char name[40];
+repeated string name = 1 [(nanopb).max_size = 40];                              pb_callback_t name;
+repeated string name = 1 [(nanopb).max_size = 40, (nanopb).max_count = 5];      | size_t name_count;
+                                                                                | char name[5][40];
+required bytes data = 1 [(nanopb).max_size = 40];                               | typedef struct {
+                                                                                |    size_t size;
+                                                                                |    uint8_t bytes[40];
+                                                                                | } Person_data_t;
+                                                                                | Person_data_t data;
+=============================================================================== =======================
+
+The maximum lengths are checked in runtime. If string/bytes/array exceeds the allocated length, *pb_decode* will return false. 
+
+For more information about callbacks, see the `Encoding` and `Decoding` sections.
+
+Field description array
+=======================
+
+For using the *pb_encode* and *pb_decode* functions, you need an array of pb_field_t constants describing the structure you wish to encode. This description is usually autogenerated from .proto file.
+
+::
+
+ message PhoneNumber {
+    required string number = 1 [(nanopb).max_size = 40];
+    optional PhoneType type = 2 [default = HOME];
+ }
+
+::
+
+ const pb_field_t Person_PhoneNumber_fields[3] = {
+    {1, PB_HTYPE_REQUIRED | PB_LTYPE_STRING,
+    offsetof(Person_PhoneNumber, number), 0,
+    pb_membersize(Person_PhoneNumber, number), 0, 0},
+
+    {2, PB_HTYPE_OPTIONAL | PB_LTYPE_VARINT,
+    pb_delta(Person_PhoneNumber, type, number),
+    pb_delta(Person_PhoneNumber, has_type, type),
+    pb_membersize(Person_PhoneNumber, type), 0,
+    &Person_PhoneNumber_type_default},
+
+    PB_LAST_FIELD
+ };
+
+For more information about the format, see the `Generated code` section.
+
+
+Return values and error handling
+================================
+
+Most functions in nanopb return bool: *true* means success, *false* means failure. If this is enough for you, skip this section.
+
+For simplicity, nanopb doesn't define it's own error codes. This might be added if there is a compelling need for it. You can however deduce something about the error causes:
+
+1) Running out of memory. Because everything is allocated from the stack, nanopb can't detect this itself. Encoding or decoding the same type of a message always takes the same amount of stack space. Therefore, if it works once, it works always.
+2) Invalid field description. These are usually stored as constants, so if it works under the debugger, it always does.
+3) IO errors in your own stream callbacks. Because encoding/decoding stops at the first error, you can overwrite the *state* field in the struct and store your own error code there.
+4) Errors that happen in your callback functions. You can use the state field in the callback structure.
+5) Exceeding the max_size or bytes_left of a stream.
+6) Exceeding the max_size of a string or array field
+7) Invalid protocol buffers binary message. It's not like you could recover from it anyway, so a simple failure should be enough.
 
-*Bytes_left* is an upper limit on the number of bytes that will be read. You can use SIZE_MAX if your callback handles EOF as described above.
+In my opinion, it is enough that 1. and 2. can be resolved using a debugger.
 
-**Example**
\ No newline at end of file
+However, you may be interested which of the remaining conditions caused the error. For 3. and 4., you can set and check the state. If you have to detect 5. and 6., you should convert the fields to callback type. Any remaining problem is of type 7.