From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from eggs.gnu.org ([2001:4830:134:3::10]:41236) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZbY12-0007Vv-SP for qemu-devel@nongnu.org; Mon, 14 Sep 2015 13:58:09 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1ZbY11-0000XW-St for qemu-devel@nongnu.org; Mon, 14 Sep 2015 13:58:08 -0400 Received: from mx1.redhat.com ([209.132.183.28]:35544) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZbY11-0000X8-Jp for qemu-devel@nongnu.org; Mon, 14 Sep 2015 13:58:07 -0400 From: Markus Armbruster Date: Mon, 14 Sep 2015 19:57:50 +0200 Message-Id: <1442253477-15422-20-git-send-email-armbru@redhat.com> In-Reply-To: <1442253477-15422-1-git-send-email-armbru@redhat.com> References: <1442253477-15422-1-git-send-email-armbru@redhat.com> Subject: [Qemu-devel] [PATCH v7 19/26] qapi: Improve built-in type documentation List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: qemu-devel@nongnu.org Cc: mdroth@linux.vnet.ibm.com Clarify how they map to JSON. Add how they map to C. Fix the reference to StringInputVisitor. Signed-off-by: Markus Armbruster Reviewed-by: Eric Blake --- docs/qapi-code-gen.txt | 29 ++++++++++++++++++----------- 1 file changed, 18 insertions(+), 11 deletions(-) diff --git a/docs/qapi-code-gen.txt b/docs/qapi-code-gen.txt index 147638f..35a4a0f 100644 --- a/docs/qapi-code-gen.txt +++ b/docs/qapi-code-gen.txt @@ -140,17 +140,24 @@ must have a value that forms a struct name. === Built-in Types === -The following types are built-in to the parser: - 'str' - arbitrary UTF-8 string - 'int' - 64-bit signed integer (although the C code may place further - restrictions on acceptable range) - 'number' - floating point number - 'bool' - JSON value of true or false - 'int8', 'int16', 'int32', 'int64' - like 'int', but enforce maximum - bit size - 'uint8', 'uint16', 'uint32', 'uint64' - unsigned counterparts - 'size' - like 'uint64', but allows scaled suffix from command line - visitor +The following types are predefined, and map to C as follows: + + Schema C JSON + str char * any JSON string, UTF-8 + number double any JSON number + int int64_t a JSON number without fractional part + that fits into the C integer type + int8 int8_t likewise + int16 int16_t likewise + int32 int32_t likewise + int64 int64_t likewise + uint8 uint8_t likewise + uint16 uint16_t likewise + uint32 uint32_t likewise + uint64 uint64_t likewise + size uint64_t like uint64_t, except StringInputVisitor + accepts size suffixes + bool bool JSON true or false === Includes === -- 2.4.3