2 * Mesa 3-D graphics library
5 * Copyright (C) 1999-2004 Brian Paul All Rights Reserved.
7 * Permission is hereby granted, free of charge, to any person obtaining a
8 * copy of this software and associated documentation files (the "Software"),
9 * to deal in the Software without restriction, including without limitation
10 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
11 * and/or sell copies of the Software, and to permit persons to whom the
12 * Software is furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included
15 * in all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
20 * BRIAN PAUL BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
21 * AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
29 #ifndef GRAMMAR_PORT_INCLUDE
30 #error Do not include this file directly, include your grammar_XXX.h instead
38 void grammar_alloc_free (void *);
39 void *grammar_alloc_malloc (size_t);
40 void *grammar_alloc_realloc (void *, size_t, size_t);
41 void *grammar_memory_copy (void *, const void *, unsigned int);
42 int grammar_string_compare (const byte
*, const byte
*);
43 int grammar_string_compare_n (const byte
*, const byte
*, size_t);
44 byte
*grammar_string_copy (byte
*, const byte
*);
45 byte
*grammar_string_copy_n (byte
*, const byte
*, size_t);
46 byte
*grammar_string_duplicate (const byte
*);
47 unsigned int grammar_string_length (const byte
*);
50 loads grammar script from null-terminated ASCII <text>
51 returns unique grammar id to grammar object
52 returns 0 if an error occurs (call grammar_get_last_error to retrieve the error text)
54 grammar
grammar_load_from_text (const byte
*text
);
57 sets a new <value> to a register <name> for grammar <id>
58 returns 0 on error (call grammar_get_last_error to retrieve the error text)
61 int grammar_set_reg8 (grammar id
, const byte
*name
, byte value
);
64 this function is obsolete, use only for debugging purposes
66 checks if a null-terminated <text> matches given grammar <id>
67 returns 0 on error (call grammar_get_last_error to retrieve the error text)
68 returns 1 on success, the <prod> points to newly allocated buffer with production and <size>
69 is filled with the production size
70 call grammar_alloc_free to free the memory block pointed by <prod>
72 int grammar_check (grammar id
, const byte
*text
, byte
**prod
, unsigned int *size
);
75 does the same what grammar_check does but much more (approx. 4 times) faster
76 use this function instead of grammar_check
77 <estimate_prod_size> is a hint - the initial production buffer size will be of this size,
78 but if more room is needed it will be safely resized; set it to 0x1000 or so
80 int grammar_fast_check (grammar id
, const byte
*text
, byte
**prod
, unsigned int *size
,
81 unsigned int estimate_prod_size
);
84 destroys grammar object identified by <id>
85 returns 0 on error (call grammar_get_last_error to retrieve the error text)
88 int grammar_destroy (grammar id
);
91 retrieves last grammar error reported either by grammar_load_from_text, grammar_check
93 the user allocated <text> buffer receives error description, <pos> points to error position,
94 <size> is the size of the text buffer to fill in - it must be at least 4 bytes long,
96 void grammar_get_last_error (byte
*text
, unsigned int size
, int *pos
);