Copyright © 1989, 1991 Free Software Foundation, Inc.,
59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
The licenses for most software are designed to take away your freedom to share and change it. By contrast, the GNU General Public License is intended to guarantee your freedom to share and change free software--to make sure the software is free for all its users. This General Public License applies to most of the Free Software Foundation's software and to any other program whose authors commit to using it. (Some other Free Software Foundation software is covered by the GNU Library General Public License instead.) You can apply it to your programs, too.
When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for this service if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs; and that you know you can do these things.
To protect your rights, we need to make restrictions that forbid anyone to deny you these rights or to ask you to surrender the rights. These restrictions translate to certain responsibilities for you if you distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether gratis or for a fee, you must give the recipients all the rights that you have. You must make sure that they, too, receive or can get the source code. And you must show them these terms so they know their rights.
We protect your rights with two steps: (1) copyright the software, and (2) offer you this license which gives you legal permission to copy, distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain that everyone understands that there is no warranty for this free software. If the software is modified by someone else and passed on, we want its recipients to know that what they have is not the original, so that any problems introduced by others will not reflect on the original authors' reputations.
Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that redistributors of a free program will individually obtain patent licenses, in effect making the program proprietary. To prevent this, we have made it clear that any patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and modification follow.
Activities other than copying, distribution and modification are not covered by this License; they are outside its scope. The act of running the Program is not restricted, and the output from the Program is covered only if its contents constitute a work based on the Program (independent of having been made by running the Program). Whether that is true depends on what the Program does.
You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee.
These requirements apply to the modified work as a whole. If identifiable sections of that work are not derived from the Program, and can be reasonably considered independent and separate works in themselves, then this License, and its terms, do not apply to those sections when you distribute them as separate works. But when you distribute the same sections as part of a whole which is a work based on the Program, the distribution of the whole must be on the terms of this License, whose permissions for other licensees extend to the entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest your rights to work written entirely by you; rather, the intent is to exercise the right to control the distribution of derivative or collective works based on the Program.
In addition, mere aggregation of another work not based on the Program with the Program (or with a work based on the Program) on a volume of a storage or distribution medium does not bring the other work under the scope of this License.
The source code for a work means the preferred form of the work for making modifications to it. For an executable work, complete source code means all the source code for all modules it contains, plus any associated interface definition files, plus the scripts used to control compilation and installation of the executable. However, as a special exception, the source code distributed need not include anything that is normally distributed (in either source or binary form) with the major components (compiler, kernel, and so on) of the operating system on which the executable runs, unless that component itself accompanies the executable.
If distribution of executable or object code is made by offering access to copy from a designated place, then offering equivalent access to copy the source code from the same place counts as distribution of the source code, even though third parties are not compelled to copy the source along with the object code.
If any portion of this section is held invalid or unenforceable under any particular circumstance, the balance of the section is intended to apply and the section as a whole is intended to apply in other circumstances.
It is not the purpose of this section to induce you to infringe any patents or other property right claims or to contest validity of any such claims; this section has the sole purpose of protecting the integrity of the free software distribution system, which is implemented by public license practices. Many people have made generous contributions to the wide range of software distributed through that system in reliance on consistent application of that system; it is up to the author/donor to decide if he or she is willing to distribute software through any other system and a licensee cannot impose that choice.
This section is intended to make thoroughly clear what is believed to be a consequence of the rest of this License.
Each version is given a distinguishing version number. If the Program specifies a version number of this License which applies to it and "any later version", you have the option of following the terms and conditions either of that version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of this License, you may choose any version ever published by the Free Software Foundation.
If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively convey the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found.
one line to give the program's name and an idea of what it does.
Copyright (C) year name of author
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'. This is free software, and you are welcome
to redistribute it under certain conditions; type `show c'
for details.
The hypothetical commands show w and show c should show
the appropriate parts of the General Public License. Of course, the
commands you use may be called something other than show w and
show c; they could even be mouse-clicks or menu items--whatever
suits your program.
You should also get your employer (if you work as a programmer) or your school, if any, to sign a "copyright disclaimer" for the program, if necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright
interest in the program `Gnomovision'
(which makes passes at compilers) written
by James Hacker.
signature of Ty Coon, 1 April 1989
Ty Coon, President of Vice
This General Public License does not permit incorporating your program into proprietary programs. If your program is a subroutine library, you may consider it more useful to permit linking proprietary applications with the library. If this is what you want to do, use the GNU Library General Public License instead of this License.
gperf Utilitygperf perfect hash function generator utility was
written in GNU C++ by Douglas C. Schmidt. The general
idea for the perfect hash function generator was inspired by Keith
Bostic's algorithm written in C, and distributed to net.sources around
1984. The current program is a heavily modified, enhanced, and extended
implementation of Keith's basic idea, created at the University of
California, Irvine. Bugs, patches, and suggestions should be reported
to <bug-gnu-gperf@gnu.org>.
In addition, Adam de Boor and Nels Olson provided many tips and insights
that greatly helped improve the quality and functionality of gperf.
gperf is a perfect hash function generator written in C++. It
transforms an n element user-specified keyword set W into a
perfect hash function F. F uniquely maps keywords in
W onto the range 0..k, where k >= n-1. If k
= n-1 then F is a minimal perfect hash function.
gperf generates a 0..k element static lookup table and a
pair of C functions. These functions determine whether a given
character string s occurs in W, using at most one probe into
the lookup table.
gperf currently generates the reserved keyword recognizer for
lexical analyzers in several production and research compilers and
language processing tools, including GNU C, GNU C++, GNU Java, GNU Pascal,
GNU Modula 3, and GNU indent. Complete C++ source code for gperf is
available from http://ftp.gnu.org/pub/gnu/gperf/.
A paper describing gperf's design and implementation in greater
detail is available in the Second USENIX C++ Conference proceedings
or from http://www.cs.wustl.edu/~schmidt/resume.html.
gperfA static search structure is an Abstract Data Type with certain
fundamental operations, e.g., initialize, insert,
and retrieve. Conceptually, all insertions occur before any
retrievals. In practice, gperf generates a static array
containing search set keywords and any associated attributes specified
by the user. Thus, there is essentially no execution-time cost for the
insertions. It is a useful data structure for representing static
search sets. Static search sets occur frequently in software system
applications. Typical static search sets include compiler reserved
words, assembler instruction opcodes, and built-in shell interpreter
commands. Search set members, called keywords, are inserted into
the structure only once, usually during program initialization, and are
not generally modified at run-time.
Numerous static search structure implementations exist, e.g., arrays, linked lists, binary search trees, digital search tries, and hash tables. Different approaches offer trade-offs between space utilization and search time efficiency. For example, an n element sorted array is space efficient, though the average-case time complexity for retrieval operations using binary search is proportional to log n. Conversely, hash table implementations often locate a table entry in constant time, but typically impose additional memory overhead and exhibit poor worst case performance.
Minimal perfect hash functions provide an optimal solution for a particular class of static search sets. A minimal perfect hash function is defined by two properties:
For most applications it is far easier to generate perfect hash
functions than minimal perfect hash functions. Moreover,
non-minimal perfect hash functions frequently execute faster than
minimal ones in practice. This phenomena occurs since searching a
sparse keyword table increases the probability of locating a "null"
entry, thereby reducing string comparisons. gperf's default
behavior generates near-minimal perfect hash functions for
keyword sets. However, gperf provides many options that permit
user control over the degree of minimality and perfection.
Static search sets often exhibit relative stability over time. For
example, Ada's 63 reserved words have remained constant for nearly a
decade. It is therefore frequently worthwhile to expend concerted
effort building an optimal search structure once, if it
subsequently receives heavy use multiple times. gperf removes
the drudgery associated with constructing time- and space-efficient
search structures by hand. It has proven a useful and practical tool
for serious programming projects. Output from gperf is currently
used in several production and research compilers, including GNU C, GNU
C++, GNU Java, GNU Pascal, and GNU Modula 3. The latter two compilers are
not yet part of the official GNU distribution. Each compiler utilizes
gperf to automatically generate static search structures that
efficiently identify their respective reserved keywords.
gperfThe perfect hash function generator gperf reads a set of
"keywords" from an input file (or from the standard input by
default). It attempts to derive a perfect hashing function that
recognizes a member of the static keyword set with at most a
single probe into the lookup table. If gperf succeeds in
generating such a function it produces a pair of C source code routines
that perform hashing and table lookup recognition. All generated C code
is directed to the standard output. Command-line options described
below allow you to modify the input and output format to gperf.
By default, gperf attempts to produce time-efficient code, with
less emphasis on efficient space utilization. However, several options
exist that permit trading-off execution time for storage space and vice
versa. In particular, expanding the generated table size produces a
sparse search structure, generally yielding faster searches.
Conversely, you can direct gperf to utilize a C switch
statement scheme that minimizes data space storage size. Furthermore,
using a C switch may actually speed up the keyword retrieval time
somewhat. Actual results depend on your C compiler, of course.
In general, gperf assigns values to the bytes it is using
for hashing until some set of values gives each keyword a unique value.
A helpful heuristic is that the larger the hash value range, the easier
it is for gperf to find and generate a perfect hash function.
Experimentation is the key to getting the most from gperf.
gperfYou can control the input file format by varying certain command-line
arguments, in particular the -t option. The input's appearance
is similar to GNU utilities flex and bison (or UNIX
utilities lex and yacc). Here's an outline of the general
format:
declarations
%%
keywords
%%
functions
Unlike flex or bison, the declarations section and
the functions section are optional. The following sections describe the
input format for each section.
It is possible to omit the declaration section entirely, if the -t
option is not given. In this case the input file begins directly with the
first keyword line, e.g.:
january
february
march
april
...
The keyword input file optionally contains a section for including
arbitrary C declarations and definitions, gperf declarations that
act like command-line options, as well as for providing a user-supplied
struct.
struct
If the -t option (or, equivalently, the %struct-type declaration)
is enabled, you must provide a C struct as the last
component in the declaration section from the input file. The first
field in this struct must be of type char * or const char *
if the -P option is not given, or of type int if the option
-P (or, equivalently, the %pic declaration) is enabled.
This first field must be called name, although it is possible to modify
its name with the -K option (or, equivalently, the
%define slot-name declaration) described below.
Here is a simple example, using months of the year and their attributes as input:
struct month { char *name; int number; int days; int leap_days; };
%%
january, 1, 31, 31
february, 2, 28, 29
march, 3, 31, 31
april, 4, 30, 30
may, 5, 31, 31
june, 6, 30, 30
july, 7, 31, 31
august, 8, 31, 31
september, 9, 30, 30
october, 10, 31, 31
november, 11, 30, 30
december, 12, 31, 31
Separating the struct declaration from the list of keywords and
other fields are a pair of consecutive percent signs, %%,
appearing left justified in the first column, as in the UNIX utility
lex.
If the struct has already been declared in an include file, it can
be mentioned in an abbreviated form, like this:
struct month;
%%
january, 1, 31, 31
...
The declaration section can contain gperf declarations. They
influence the way gperf works, like command line options do.
In fact, every such declaration is equivalent to a command line option.
There are three forms of declarations:
%compare-lengths.
%switch=count%define lookup-function-name nameWhen a declaration is given both in the input file and as a command line option, the command-line option's value prevails.
The following gperf declarations are available.
%delimiters=delimiter-list%struct-type
struct type declaration for generated
code; see above for an example.
%ignore-case
%language=language-namegperf to generate code in the language specified by the
option's argument. Languages handled are currently:
KR-C
const.
C
#define const to empty
for compilers which don't know about this keyword.
ANSI-C
C++
The default is C.
%define slot-name name-t (or, equivalently, the
%struct-type declaration) has been given.
By default, the program assumes the structure component identifier for
the keyword is name. This option allows an arbitrary choice of
identifier for this component, although it still must occur as the first
field in your supplied struct.
%define initializer-suffix initializers-t (or, equivalently, the
%struct-type declaration) has been given.
It permits to specify initializers for the structure members following
slot-name in empty hash table entries. The list of initializers
should start with a comma. By default, the emitted code will
zero-initialize structure members following slot-name.
%define hash-function-name namehash. This option permits the use of two hash tables in
the same file.
%define lookup-function-name namein_word_set. This option permits multiple
generated hash functions to be used in the same application.
%define class-name name-L C++ (or, equivalently,
the %language=C++ declaration) has been given. It
allows you to specify the name of generated C++ class. Default name is
Perfect_Hash.
%7bit
isalnum and isgraph do
not guarantee that a byte is in this range. Only an explicit
test like c >= 'A' && c <= 'Z' guarantees this.)
%compare-lengths
strcmp.
However, using %compare-lengths might greatly increase the size of the
generated C code if the lookup table range is large (which implies that
the switch option -S or %switch is not enabled), since the length
table contains as many elements as there are entries in the lookup table.
%compare-strncmp
strncmp function to perform
string comparisons. The default action is to use strcmp.
%readonly-tables
%enum
<jjc@ai.mit.edu>.
%includes
<string.h>, at the
beginning of the code. By default, this is not done; the user must
include this header file himself to allow compilation of the code.
%global-table
%pic
%struct-type declaration (or,
equivalently, the option -t) is also given, the first field of the
user-defined struct must be of type int, not char *, because
it will contain offsets into the string pool instead of actual strings.
To convert such an offset to a string, you can use the expression
stringpool + o%define string-pool-name declaration.
%define string-pool-name name%pic (or, equivalently, the option -P).
The default name is stringpool. This declaration permits the use of
two hash tables in the same file, with %pic and even when the
%global-table declaration (or, equivalently, the option -G)
is given.
%null-strings
%pic), at the
expense of one more test-and-branch instruction at run time.
%define word-array-name namewordlist. This option permits the
use of two hash tables in the same file, even when the option -G
(or, equivalently, the %global-table declaration) is given.
%switch=countswitch statement scheme,
rather than an array lookup table. This can lead to a reduction in both
time and space requirements for some input files. The argument to this
option determines how many switch statements are generated. A
value of 1 generates 1 switch containing all the elements, a
value of 2 generates 2 tables with 1/2 the elements in each
switch, etc. This is useful since many C compilers cannot
correctly generate code for large switch statements. This option
was inspired in part by Keith Bostic's original C program.
%omit-struct-type
Using a syntax similar to GNU utilities flex and bison, it
is possible to directly include C source text and comments verbatim into
the generated output file. This is accomplished by enclosing the region
inside left-justified surrounding %{, %} pairs. Here is
an input fragment based on the previous example that illustrates this
feature:
%{
#include <assert.h>
/* This section of code is inserted directly into the output. */
int return_month_days (struct month *months, int is_leap_year);
%}
struct month { char *name; int number; int days; int leap_days; };
%%
january, 1, 31, 31
february, 2, 28, 29
march, 3, 31, 31
...
The second input file format section contains lines of keywords and any
associated attributes you might supply. A line beginning with #
in the first column is considered a comment. Everything following the
# is ignored, up to and including the following newline. A line
beginning with % in the first column is an option declaration and
must not occur within the keywords section.
The first field of each non-comment line is always the keyword itself. It
can be given in two ways: as a simple name, i.e., without surrounding
string quotation marks, or as a string enclosed in double-quotes, in
C syntax, possibly with backslash escapes like \" or \234
or \xa8. In either case, it must start right at the beginning
of the line, without leading whitespace.
In this context, a "field" is considered to extend up to, but
not include, the first blank, comma, or newline. Here is a simple
example taken from a partial list of C reserved words:
# These are a few C reserved words, see the c.gperf file
# for a complete list of ANSI C reserved words.
unsigned
sizeof
switch
signed
if
default
for
while
return
Note that unlike flex or bison the first %% marker
may be elided if the declaration section is empty.
Additional fields may optionally follow the leading keyword. Fields
should be separated by commas, and terminate at the end of line. What
these fields mean is entirely up to you; they are used to initialize the
elements of the user-defined struct provided by you in the
declaration section. If the -t option (or, equivalently, the
%struct-type declaration) is not enabled
these fields are simply ignored. All previous examples except the last
one contain keyword attributes.
The optional third section also corresponds closely with conventions
found in flex and bison. All text in this section,
starting at the final %% and extending to the end of the input
file, is included verbatim into the generated output file. Naturally,
it is your responsibility to ensure that the code contained in this
section is valid C.
indent.
If you want to invoke GNU indent on a gperf input file,
you will see that GNU indent doesn't understand the %%,
%{ and %} directives that control gperf's
interpretation of the input file. Therefore you have to insert some
directives for GNU indent. More precisely, assuming the most
general input file structure
declarations part 1
%{
verbatim code
%}
declarations part 2
%%
keywords
%%
functions
you would insert *INDENT-OFF* and *INDENT-ON* comments
as follows:
/* *INDENT-OFF* */
declarations part 1
%{
/* *INDENT-ON* */
verbatim code
/* *INDENT-OFF* */
%}
declarations part 2
%%
keywords
%%
/* *INDENT-ON* */
functions
gperfSeveral options control how the generated C code appears on the standard
output. Two C function are generated. They are called hash and
in_word_set, although you may modify their names with a command-line
option. Both functions require two arguments, a string, char *
str, and a length parameter, int len. Their default
function prototypes are as follows:
| unsigned int hash (const char * str, unsigned int len) | Functie |
By default, the generated hash function returns an integer value
created by adding len to several user-specified str byte
positions indexed into an associated values table stored in a
local static array. The associated values table is constructed
internally by gperf and later output as a static local C array
called hash_table. The relevant selected positions (i.e. indices
into str) are specified via the -k option when running
gperf, as detailed in the Options section below (see Options).
|
| in_word_set (const char * str, unsigned int len) | Functie |
If str is in the keyword set, returns a pointer to that
keyword. More exactly, if the option -t (or, equivalently, the
%struct-type declaration) was given, it returns
a pointer to the matching keyword's structure. Otherwise it returns
NULL.
|
If the option -c (or, equivalently, the %compare-strncmp
declaration) is not used, str must be a NUL terminated
string of exactly length len. If -c (or, equivalently, the
%compare-strncmp declaration) is used, str must
simply be an array of len bytes and does not need to be NUL
terminated.
The code generated for these two functions is affected by the following options:
-t
--struct-type
struct.
-S total-switch-statements--switch=total-switch-statementsswitch statement rather than use a large,
(and potentially sparse) static array. Although the exact time and
space savings of this approach vary according to your C compiler's
degree of optimization, this method often results in smaller and faster
code.
If the -t and -S options (or, equivalently, the
%struct-type and %switch declarations) are omitted, the default
action
is to generate a char * array containing the keywords, together with
additional empty strings used for padding the array. By experimenting
with the various input and output options, and timing the resulting C
code, you can determine the best option choices for different keyword
set characteristics.
By default, the code generated by gperf operates on zero
terminated strings, the usual representation of strings in C. This means
that the keywords in the input file must not contain NUL bytes,
and the str argument passed to hash or in_word_set
must be NUL terminated and have exactly length len.
If option -c (or, equivalently, the %compare-strncmp
declaration) is used, then the str argument does not need
to be NUL terminated. The code generated by gperf will only
access the first len, not len+1, bytes starting at str.
However, the keywords in the input file still must not contain NUL
bytes.
If option -l (or, equivalently, the %compare-lengths
declaration) is used, then the hash table performs binary
comparison. The keywords in the input file may contain NUL bytes,
written in string syntax as \000 or \x00, and the code
generated by gperf will treat NUL like any other byte.
Also, in this case the -c option (or, equivalently, the
%compare-strncmp declaration) is ignored.
gperfThere are many options to gperf. They were added to make
the program more convenient for use with real applications. "On-line"
help is readily available via the --help option. Here is the
complete list of options.
--output-file=fileThe results are written to standard output if no output file is specified
or if it is -.
These options are also available as declarations in the input file (see Gperf Declarations).
-e keyword-delimiter-list--delimiters=keyword-delimiter-list-t
--struct-type
struct type declaration for generated
code. Any text before a pair of consecutive %% is considered
part of the type declaration. Keywords and additional fields may follow
this, one group of fields per line. A set of examples for generating
perfect hash tables and functions for Ada, C, C++, Pascal, Modula 2,
Modula 3 and JavaScript reserved words are distributed with this release.
--ignore-case
i is the non-ASCII character
capital i with dot above.) For this case, it is better to apply
an uppercase or lowercase conversion on the string before passing it to
the gperf generated function.
These options are also available as declarations in the input file (see Gperf Declarations).
-L generated-language-name--language=generated-language-namegperf to generate code in the language specified by the
option's argument. Languages handled are currently:
KR-C
const.
C
#define const to empty
for compilers which don't know about this keyword.
ANSI-C
C++
The default is C.
-a
gperf. It does not do anything.
-g
gperf. It does not do anything.
Most of these options are also available as declarations in the input file (see Gperf Declarations).
-K slot-name--slot-name=slot-name-t (or, equivalently, the
%struct-type declaration) has been given.
By default, the program assumes the structure component identifier for
the keyword is name. This option allows an arbitrary choice of
identifier for this component, although it still must occur as the first
field in your supplied struct.
-F initializers--initializer-suffix=initializers-t (or, equivalently, the
%struct-type declaration) has been given.
It permits to specify initializers for the structure members following
slot-name in empty hash table entries. The list of initializers
should start with a comma. By default, the emitted code will
zero-initialize structure members following slot-name.
-H hash-function-name--hash-function-name=hash-function-namehash. This option permits the use of two hash tables in
the same file.
-N lookup-function-name--lookup-function-name=lookup-function-namein_word_set. This option permits multiple
generated hash functions to be used in the same application.
-Z class-name--class-name=class-name-L C++ (or, equivalently,
the %language=C++ declaration) has been given. It
allows you to specify the name of generated C++ class. Default name is
Perfect_Hash.
-7
--seven-bit
isalnum and isgraph do
not guarantee that a byte is in this range. Only an explicit
test like c >= 'A' && c <= 'Z' guarantees this.) This was the
default in versions of gperf earlier than 2.7; now the default is
to support 8-bit and multibyte characters.
-l
--compare-lengths
strcmp.
However, using -l might greatly increase the size of the
generated C code if the lookup table range is large (which implies that
the switch option -S or %switch is not enabled), since the length
table contains as many elements as there are entries in the lookup table.
-c
--compare-strncmp
strncmp function to perform
string comparisons. The default action is to use strcmp.
-C
--readonly-tables
-E
--enum
<jjc@ai.mit.edu>.
-I
--includes
<string.h>, at the
beginning of the code. By default, this is not done; the user must
include this header file himself to allow compilation of the code.
-G
--global-table
-P
--pic
-t (or, equivalently, the
%struct-type declaration) is also given, the first field of the
user-defined struct must be of type int, not char *, because
it will contain offsets into the string pool instead of actual strings.
To convert such an offset to a string, you can use the expression
stringpool + o--string-pool-name.
-Q string-pool-name--string-pool-name=string-pool-name-P. The default name is stringpool. This option
permits the use of two hash tables in the same file, with -P and
even when the option -G (or, equivalently, the %global-table
declaration) is given.
--null-strings
-P), at the expense
of one more test-and-branch instruction at run time.
-W hash-table-array-name--word-array-name=hash-table-array-namewordlist. This option permits the
use of two hash tables in the same file, even when the option -G
(or, equivalently, the %global-table declaration) is given.
-S total-switch-statements--switch=total-switch-statementsswitch statement scheme,
rather than an array lookup table. This can lead to a reduction in both
time and space requirements for some input files. The argument to this
option determines how many switch statements are generated. A
value of 1 generates 1 switch containing all the elements, a
value of 2 generates 2 tables with 1/2 the elements in each
switch, etc. This is useful since many C compilers cannot
correctly generate code for large switch statements. This option
was inspired in part by Keith Bostic's original C program.
-T
--omit-struct-type
-p
gperf. It does not do anything.
gperf-k selected-byte-positions--key-positions=selected-byte-positions-k 9,4,13,14;
ranges may be used, e.g., -k 2-7; and positions may occur
in any order. Furthermore, the wildcard '*' causes the generated
hash function to consider all byte positions in each keyword,
whereas '$' instructs the hash function to use the "final byte"
of a keyword (this is the only way to use a byte position greater than
255, incidentally).
For instance, the option -k 1,2,4,6-10,'$' generates a hash
function that considers positions 1,2,4,6,7,8,9,10, plus the last
byte in each keyword (which may be at a different position for each
keyword, obviously). Keywords
with length less than the indicated byte positions work properly, since
selected byte positions exceeding the keyword length are simply not
referenced in the hash function.
This option is not normally needed since version 2.8 of gperf;
the default byte positions are computed depending on the keyword set,
through a search that minimizes the number of byte positions.
-D
--duplicates
gperf treats all these keywords as
part of an equivalence class and generates a perfect hash function with
multiple comparisons for duplicate keywords. It is up to you to completely
disambiguate the keywords by modifying the generated C code. However,
gperf helps you out by organizing the output.
Using this option usually means that the generated hash function is no
longer perfect. On the other hand, it permits gperf to work on
keyword sets that it otherwise could not handle.
-m iterations--multiple-iterations=iterations-i and -j values, and
choose the best results. This increases the running time by a factor of
iterations but does a good job minimizing the generated table size.
-i initial-value--initial-asso=initial-value-S (or, equivalently,
%switch) is used. Also,
-i is overridden when the -r option is used.
-j jump-value--jump=jump-valuegperf
jumps by random amounts.
-n
--no-strlen
-r
--random
-s size-multiple--size-multiple=size-multiple-m is better at this purpose.
If `generate switch' option -S (or, equivalently, %switch) is
not enabled, the maximum
associated value influences the static array table size, and a larger
table should decrease the time required for an unsuccessful search, at
the expense of extra table space.
The default value is 1, thus the default maximum associated value about the same size as the number of keywords (for efficiency, the maximum associated value is always rounded up to a power of 2). The actual table size may vary somewhat, since this technique is essentially a heuristic.
-h
--help
-v
--version
-d
--debug
gperf is executing. It is useful both for
maintaining the program and for determining whether a given set of
options is actually speeding up the search for a solution. Some useful
information is dumped at the end of the program when the -d
option is enabled.
gperfThe following are some limitations with the current release of
gperf:
gperf utility is tuned to execute quickly, and works quickly
for small to medium size data sets (around 1000 keywords). It is
extremely useful for maintaining perfect hash functions for compiler
keyword sets. Several recent enhancements now enable gperf to
work efficiently on much larger keyword sets (over 15,000 keywords).
When processing large keyword sets it helps greatly to have over 8 megs
of RAM.
-S option to reduce data
size, potentially increasing keyword recognition time a negligible
amount. Since many C compilers cannot correctly generate code for
large switch statements it is important to qualify the -S option
with an appropriate numerical argument that controls the number of
switch statements generated.
It should be "relatively" easy to replace the current perfect hash function algorithm with a more exhaustive approach; the perfect hash module is essential independent from other program modules. Additional worthwhile improvements include:
-S switch
option can minimize the data size, at the expense of slightly longer
lookups (note that the gcc compiler generally produces good code for
switch statements, reducing the need for more complex schemes).
[1] Chang, C.C.: A Scheme for Constructing Ordered Minimal Perfect Hashing Functions Information Sciences 39(1986), 187-195.
[2] Cichelli, Richard J. Author's Response to "On Cichelli's Minimal Perfect Hash Functions Method" Communications of the ACM, 23, 12(December 1980), 729.
[3] Cichelli, Richard J. Minimal Perfect Hash Functions Made Simple Communications of the ACM, 23, 1(January 1980), 17-19.
[4] Cook, C. R. and Oldehoeft, R.R. A Letter Oriented Minimal Perfect Hashing Function SIGPLAN Notices, 17, 9(September 1982), 18-27.
[5] Cormack, G. V. and Horspool, R. N. S. and Kaiserwerth, M. Practical Perfect Hashing Computer Journal, 28, 1(January 1985), 54-58.
[6] Jaeschke, G. Reciprocal Hashing: A Method for Generating Minimal Perfect Hashing Functions Communications of the ACM, 24, 12(December 1981), 829-833.
[7] Jaeschke, G. and Osterburg, G. On Cichelli's Minimal Perfect Hash Functions Method Communications of the ACM, 23, 12(December 1980), 728-729.
[8] Sager, Thomas J. A Polynomial Time Generator for Minimal Perfect Hash Functions Communications of the ACM, 28, 5(December 1985), 523-532
[9] Schmidt, Douglas C. GPERF: A Perfect Hash Function Generator Second USENIX C++ Conference Proceedings, April 1990.
[10] Schmidt, Douglas C. GPERF: A Perfect Hash Function Generator C++ Report, SIGS 10 10 (November/December 1998).
[11] Sebesta, R.W. and Taylor, M.A. Minimal Perfect Hash Functions for Reserved Word Lists SIGPLAN Notices, 20, 12(September 1985), 47-53.
[12] Sprugnoli, R. Perfect Hashing Functions: A Single Probe Retrieving Method for Static Sets Communications of the ACM, 20 11(November 1977), 841-850.
[13] Stallman, Richard M. Using and Porting GNU CC Free Software Foundation, 1988.
[14] Stroustrup, Bjarne The C++ Programming Language. Addison-Wesley, 1986.
[15] Tiemann, Michael D. User's Guide to GNU C++ Free Software Foundation, 1989.
%%: User-supplied Struct
%7bit: Gperf Declarations
%compare-lengths: Gperf Declarations
%compare-strncmp: Gperf Declarations
%define class-name: Gperf Declarations
%define hash-function-name: Gperf Declarations
%define initializer-suffix: Gperf Declarations
%define lookup-function-name: Gperf Declarations
%define slot-name: Gperf Declarations
%define string-pool-name: Gperf Declarations
%define word-array-name: Gperf Declarations
%delimiters: Gperf Declarations
%enum: Gperf Declarations
%global-table: Gperf Declarations
%ignore-case: Gperf Declarations
%includes: Gperf Declarations
%language: Gperf Declarations
%null-strings: Gperf Declarations
%omit-struct-type: Gperf Declarations
%pic: Gperf Declarations
%readonly-tables: Gperf Declarations
%struct-type: Gperf Declarations
%switch: Gperf Declarations
%{: C Code Inclusion
%}: C Code Inclusion
hash: Output Format
in_word_set: Output Format
switch: Output Details, Output Format
gperf Utility
gperf
gperf
gperf
gperf