diff --git a/.gitignore b/.gitignore index ec5647f..0daf8ff 100644 --- a/.gitignore +++ b/.gitignore @@ -41,3 +41,4 @@ debian/libsexpr* debian/files debian/tmp compile +INSTALL diff --git a/INSTALL b/INSTALL deleted file mode 100644 index 8865734..0000000 --- a/INSTALL +++ /dev/null @@ -1,368 +0,0 @@ -Installation Instructions -************************* - - Copyright (C) 1994-1996, 1999-2002, 2004-2016 Free Software -Foundation, Inc. - - Copying and distribution of this file, with or without modification, -are permitted in any medium without royalty provided the copyright -notice and this notice are preserved. This file is offered as-is, -without warranty of any kind. - -Basic Installation -================== - - Briefly, the shell command './configure && make && make install' -should configure, build, and install this package. The following -more-detailed instructions are generic; see the 'README' file for -instructions specific to this package. Some packages provide this -'INSTALL' file but do not implement all of the features documented -below. The lack of an optional feature in a given package is not -necessarily a bug. More recommendations for GNU packages can be found -in *note Makefile Conventions: (standards)Makefile Conventions. - - The 'configure' shell script attempts to guess correct values for -various system-dependent variables used during compilation. It uses -those values to create a 'Makefile' in each directory of the package. -It may also create one or more '.h' files containing system-dependent -definitions. Finally, it creates a shell script 'config.status' that -you can run in the future to recreate the current configuration, and a -file 'config.log' containing compiler output (useful mainly for -debugging 'configure'). - - It can also use an optional file (typically called 'config.cache' and -enabled with '--cache-file=config.cache' or simply '-C') that saves the -results of its tests to speed up reconfiguring. Caching is disabled by -default to prevent problems with accidental use of stale cache files. - - If you need to do unusual things to compile the package, please try -to figure out how 'configure' could check whether to do them, and mail -diffs or instructions to the address given in the 'README' so they can -be considered for the next release. If you are using the cache, and at -some point 'config.cache' contains results you don't want to keep, you -may remove or edit it. - - The file 'configure.ac' (or 'configure.in') is used to create -'configure' by a program called 'autoconf'. You need 'configure.ac' if -you want to change it or regenerate 'configure' using a newer version of -'autoconf'. - - The simplest way to compile this package is: - - 1. 'cd' to the directory containing the package's source code and type - './configure' to configure the package for your system. - - Running 'configure' might take a while. While running, it prints - some messages telling which features it is checking for. - - 2. Type 'make' to compile the package. - - 3. Optionally, type 'make check' to run any self-tests that come with - the package, generally using the just-built uninstalled binaries. - - 4. Type 'make install' to install the programs and any data files and - documentation. When installing into a prefix owned by root, it is - recommended that the package be configured and built as a regular - user, and only the 'make install' phase executed with root - privileges. - - 5. Optionally, type 'make installcheck' to repeat any self-tests, but - this time using the binaries in their final installed location. - This target does not install anything. Running this target as a - regular user, particularly if the prior 'make install' required - root privileges, verifies that the installation completed - correctly. - - 6. You can remove the program binaries and object files from the - source code directory by typing 'make clean'. To also remove the - files that 'configure' created (so you can compile the package for - a different kind of computer), type 'make distclean'. There is - also a 'make maintainer-clean' target, but that is intended mainly - for the package's developers. If you use it, you may have to get - all sorts of other programs in order to regenerate files that came - with the distribution. - - 7. Often, you can also type 'make uninstall' to remove the installed - files again. In practice, not all packages have tested that - uninstallation works correctly, even though it is required by the - GNU Coding Standards. - - 8. Some packages, particularly those that use Automake, provide 'make - distcheck', which can by used by developers to test that all other - targets like 'make install' and 'make uninstall' work correctly. - This target is generally not run by end users. - -Compilers and Options -===================== - - Some systems require unusual options for compilation or linking that -the 'configure' script does not know about. Run './configure --help' -for details on some of the pertinent environment variables. - - You can give 'configure' initial values for configuration parameters -by setting variables in the command line or in the environment. Here is -an example: - - ./configure CC=c99 CFLAGS=-g LIBS=-lposix - - *Note Defining Variables::, for more details. - -Compiling For Multiple Architectures -==================================== - - You can compile the package for more than one kind of computer at the -same time, by placing the object files for each architecture in their -own directory. To do this, you can use GNU 'make'. 'cd' to the -directory where you want the object files and executables to go and run -the 'configure' script. 'configure' automatically checks for the source -code in the directory that 'configure' is in and in '..'. This is known -as a "VPATH" build. - - With a non-GNU 'make', it is safer to compile the package for one -architecture at a time in the source code directory. After you have -installed the package for one architecture, use 'make distclean' before -reconfiguring for another architecture. - - On MacOS X 10.5 and later systems, you can create libraries and -executables that work on multiple system types--known as "fat" or -"universal" binaries--by specifying multiple '-arch' options to the -compiler but only a single '-arch' option to the preprocessor. Like -this: - - ./configure CC="gcc -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CXX="g++ -arch i386 -arch x86_64 -arch ppc -arch ppc64" \ - CPP="gcc -E" CXXCPP="g++ -E" - - This is not guaranteed to produce working output in all cases, you -may have to build one architecture at a time and combine the results -using the 'lipo' tool if you have problems. - -Installation Names -================== - - By default, 'make install' installs the package's commands under -'/usr/local/bin', include files under '/usr/local/include', etc. You -can specify an installation prefix other than '/usr/local' by giving -'configure' the option '--prefix=PREFIX', where PREFIX must be an -absolute file name. - - You can specify separate installation prefixes for -architecture-specific files and architecture-independent files. If you -pass the option '--exec-prefix=PREFIX' to 'configure', the package uses -PREFIX as the prefix for installing programs and libraries. -Documentation and other data files still use the regular prefix. - - In addition, if you use an unusual directory layout you can give -options like '--bindir=DIR' to specify different values for particular -kinds of files. Run 'configure --help' for a list of the directories -you can set and what kinds of files go in them. In general, the default -for these options is expressed in terms of '${prefix}', so that -specifying just '--prefix' will affect all of the other directory -specifications that were not explicitly provided. - - The most portable way to affect installation locations is to pass the -correct locations to 'configure'; however, many packages provide one or -both of the following shortcuts of passing variable assignments to the -'make install' command line to change installation locations without -having to reconfigure or recompile. - - The first method involves providing an override variable for each -affected directory. For example, 'make install -prefix=/alternate/directory' will choose an alternate location for all -directory configuration variables that were expressed in terms of -'${prefix}'. Any directories that were specified during 'configure', -but not in terms of '${prefix}', must each be overridden at install time -for the entire installation to be relocated. The approach of makefile -variable overrides for each directory variable is required by the GNU -Coding Standards, and ideally causes no recompilation. However, some -platforms have known limitations with the semantics of shared libraries -that end up requiring recompilation when using this method, particularly -noticeable in packages that use GNU Libtool. - - The second method involves providing the 'DESTDIR' variable. For -example, 'make install DESTDIR=/alternate/directory' will prepend -'/alternate/directory' before all installation names. The approach of -'DESTDIR' overrides is not required by the GNU Coding Standards, and -does not work on platforms that have drive letters. On the other hand, -it does better at avoiding recompilation issues, and works well even -when some directory options were not specified in terms of '${prefix}' -at 'configure' time. - -Optional Features -================= - - If the package supports it, you can cause programs to be installed -with an extra prefix or suffix on their names by giving 'configure' the -option '--program-prefix=PREFIX' or '--program-suffix=SUFFIX'. - - Some packages pay attention to '--enable-FEATURE' options to -'configure', where FEATURE indicates an optional part of the package. -They may also pay attention to '--with-PACKAGE' options, where PACKAGE -is something like 'gnu-as' or 'x' (for the X Window System). The -'README' should mention any '--enable-' and '--with-' options that the -package recognizes. - - For packages that use the X Window System, 'configure' can usually -find the X include and library files automatically, but if it doesn't, -you can use the 'configure' options '--x-includes=DIR' and -'--x-libraries=DIR' to specify their locations. - - Some packages offer the ability to configure how verbose the -execution of 'make' will be. For these packages, running './configure ---enable-silent-rules' sets the default to minimal output, which can be -overridden with 'make V=1'; while running './configure ---disable-silent-rules' sets the default to verbose, which can be -overridden with 'make V=0'. - -Particular systems -================== - - On HP-UX, the default C compiler is not ANSI C compatible. If GNU CC -is not installed, it is recommended to use the following options in -order to use an ANSI C compiler: - - ./configure CC="cc -Ae -D_XOPEN_SOURCE=500" - -and if that doesn't work, install pre-built binaries of GCC for HP-UX. - - HP-UX 'make' updates targets which have the same time stamps as their -prerequisites, which makes it generally unusable when shipped generated -files such as 'configure' are involved. Use GNU 'make' instead. - - On OSF/1 a.k.a. Tru64, some versions of the default C compiler cannot -parse its '' header file. The option '-nodtk' can be used as a -workaround. If GNU CC is not installed, it is therefore recommended to -try - - ./configure CC="cc" - -and if that doesn't work, try - - ./configure CC="cc -nodtk" - - On Solaris, don't put '/usr/ucb' early in your 'PATH'. This -directory contains several dysfunctional programs; working variants of -these programs are available in '/usr/bin'. So, if you need '/usr/ucb' -in your 'PATH', put it _after_ '/usr/bin'. - - On Haiku, software installed for all users goes in '/boot/common', -not '/usr/local'. It is recommended to use the following options: - - ./configure --prefix=/boot/common - -Specifying the System Type -========================== - - There may be some features 'configure' cannot figure out -automatically, but needs to determine by the type of machine the package -will run on. Usually, assuming the package is built to be run on the -_same_ architectures, 'configure' can figure that out, but if it prints -a message saying it cannot guess the machine type, give it the -'--build=TYPE' option. TYPE can either be a short name for the system -type, such as 'sun4', or a canonical name which has the form: - - CPU-COMPANY-SYSTEM - -where SYSTEM can have one of these forms: - - OS - KERNEL-OS - - See the file 'config.sub' for the possible values of each field. If -'config.sub' isn't included in this package, then this package doesn't -need to know the machine type. - - If you are _building_ compiler tools for cross-compiling, you should -use the option '--target=TYPE' to select the type of system they will -produce code for. - - If you want to _use_ a cross compiler, that generates code for a -platform different from the build platform, you should specify the -"host" platform (i.e., that on which the generated programs will -eventually be run) with '--host=TYPE'. - -Sharing Defaults -================ - - If you want to set default values for 'configure' scripts to share, -you can create a site shell script called 'config.site' that gives -default values for variables like 'CC', 'cache_file', and 'prefix'. -'configure' looks for 'PREFIX/share/config.site' if it exists, then -'PREFIX/etc/config.site' if it exists. Or, you can set the -'CONFIG_SITE' environment variable to the location of the site script. -A warning: not all 'configure' scripts look for a site script. - -Defining Variables -================== - - Variables not defined in a site shell script can be set in the -environment passed to 'configure'. However, some packages may run -configure again during the build, and the customized values of these -variables may be lost. In order to avoid this problem, you should set -them in the 'configure' command line, using 'VAR=value'. For example: - - ./configure CC=/usr/local2/bin/gcc - -causes the specified 'gcc' to be used as the C compiler (unless it is -overridden in the site shell script). - -Unfortunately, this technique does not work for 'CONFIG_SHELL' due to an -Autoconf limitation. Until the limitation is lifted, you can use this -workaround: - - CONFIG_SHELL=/bin/bash ./configure CONFIG_SHELL=/bin/bash - -'configure' Invocation -====================== - - 'configure' recognizes the following options to control how it -operates. - -'--help' -'-h' - Print a summary of all of the options to 'configure', and exit. - -'--help=short' -'--help=recursive' - Print a summary of the options unique to this package's - 'configure', and exit. The 'short' variant lists options used only - in the top level, while the 'recursive' variant lists options also - present in any nested packages. - -'--version' -'-V' - Print the version of Autoconf used to generate the 'configure' - script, and exit. - -'--cache-file=FILE' - Enable the cache: use and save the results of the tests in FILE, - traditionally 'config.cache'. FILE defaults to '/dev/null' to - disable caching. - -'--config-cache' -'-C' - Alias for '--cache-file=config.cache'. - -'--quiet' -'--silent' -'-q' - Do not print messages saying which checks are being made. To - suppress all normal output, redirect it to '/dev/null' (any error - messages will still be shown). - -'--srcdir=DIR' - Look for the package's source code in directory DIR. Usually - 'configure' can determine that directory automatically. - -'--prefix=DIR' - Use DIR as the installation prefix. *note Installation Names:: for - more details, including other options available for fine-tuning the - installation locations. - -'--no-create' -'-n' - Run the configure checks, but stop before creating any output - files. - -'configure' also accepts some other, not widely useful, options. Run -'configure --help' for more details. diff --git a/include/sexpr/sexp.h b/include/sexpr/sexp.h index 7f6a0fc..4401050 100644 --- a/include/sexpr/sexp.h +++ b/include/sexpr/sexp.h @@ -567,13 +567,30 @@ typedef struct sexp_iowrap { size_t cnt; } sexp_iowrap_t; -/* TODO: doxygen? more doxygen */ +/** + * \ingroup IO + * This structure is a wrapper around a the parsing infrastructure (continuation + * and a buffer) required to parse off of it. This is used so that routines can + * hide the loops and details required to accumulate up data read off of the buffer. + */ typedef struct sexp_cstrwrap { - pcont_t *cc; /* continuation used to parse */ - const char *seval; /* pointer used to the original piece */ + /** + * Continuation used to parse off of the given buffer + */ + pcont_t *cc; + /** + * A pointer to the cstring data to parse + */ + const char *seval; + /** + * different counters used to have a deal with source and buffer + */ size_t rl, cnt; size_t sln; - char buf[CSTRBUFSIZ]; /* internal buffer */ + /** + * Temproary buffer used to parse + */ + char buf[CSTRBUFSIZ]; } sexp_cstrwrap_t; /*========*/ @@ -629,7 +646,7 @@ extern "C" { * return an allocated sexp_t. This structure may be an already allocated * one from the stack or a new one if none are available. Use this instead * of manually mallocing if you want to avoid excessive mallocs. Note: - * Mallocing your own expressions is fine - you can even use + * Mallocing your own expressions is fine - you can even use * sexp_t_deallocate to deallocate them and put them in the pool. * Also, if the stack has not been initialized yet, this does so. */ @@ -641,7 +658,7 @@ extern "C" { * allocated already. */ void sexp_t_deallocate(sexp_t *s); - + /** * In the event that someone wants us to release ALL of the memory used * between calls by the library, they can free it. If you don't call @@ -689,7 +706,7 @@ extern "C" { * element is carrying a binary pointer only. */ sexp_t *new_sexp_binary_atom(char *data, size_t binlength); - + /** * Allocate a new sexp_t element representing a value. The user must * specify the precise type of the atom. This used to default to @@ -701,9 +718,9 @@ extern "C" { * wanted. */ sexp_t *new_sexp_atom(const char *buf, size_t bs, atom_t aty); - - /** - * create an initial continuation for parsing the given string + + /** + * create an initial continuation for parsing the given string */ pcont_t *init_continuation(char *str); @@ -730,7 +747,7 @@ extern "C" { void destroy_iowrap(sexp_iowrap_t *iow); /** - * \ingroup IO + * \ingroup IO * given and IO wrapper handle, read one s-expression * off of it. this expression may be contained in a continuation, * so there is no guarantee that under the covers an IO read @@ -741,27 +758,43 @@ extern "C" { * problematic error. */ sexp_t *read_one_sexp(sexp_iowrap_t *iow); - - /** + + /** + * \ingroup IO + * create an wrapper structure around a c string buffer. A NULL return + * value indicates some problem occurred allocating the wrapper, so the + * user should check the value of sexp_errno for further information. + */ + sexp_cstrwrap_t *init_cstrwrap(const char *); + + /** + * \ingroup IO + * destroy a wrapper structure. + */ + void destroy_cstrwrap(sexp_cstrwrap_t *); + + sexp_t *get_one_sexp(sexp_cstrwrap_t *); + + /** * \ingroup parser - * wrapper around parser for compatibility. + * wrapper around parser for compatibility. */ sexp_t *parse_sexp(char *s, size_t len); - /** + /** * \ingroup parser - * wrapper around parser for friendlier continuation use - * pre-condition : continuation (cc) is NON-NULL! + * wrapper around parser for friendlier continuation use + * pre-condition : continuation (cc) is NON-NULL! */ sexp_t *iparse_sexp(char *s, size_t len, pcont_t *cc); - + /** * \ingroup parser * given a LISP style s-expression string, parse it into a set of - * connected sexp_t structures. + * connected sexp_t structures. */ pcont_t *cparse_sexp(char *s, size_t len, pcont_t *pc); - + /** * given a sexp_t structure, free the memory it uses (and recursively free * the memory used by all sexp_t structures that it references). Note diff --git a/lib/Makefile.am b/lib/Makefile.am index d15eb8b..203e320 100644 --- a/lib/Makefile.am +++ b/lib/Makefile.am @@ -14,7 +14,7 @@ lib_LTLIBRARIES = libsexpr.la libsexpr_la_SOURCES = \ - cstring.c event_temp.c faststack.c io.c \ + cstring.c event_temp.c faststack.c io.c cswrap.c \ parser.c sexp.c sexp_memory.c sexp_ops.c sexp_vis.c libsexpr_la_LDFLAGS = diff --git a/lib/cswrap.c b/lib/cswrap.c new file mode 100644 index 0000000..bf3c254 --- /dev/null +++ b/lib/cswrap.c @@ -0,0 +1,136 @@ +/** +@cond IGNORE + +A wrapper functions to deal with a cstrings done as an io wrapper +Copyright (C) 2018 Alexander Vdolainen + + +It is free software: you can redistribute it and/or modify it +under the terms of the GNU Lesser General Public License as published +by the Free Software Foundation, either version 2.1 of the License, or +(at your option) any later version. + +This 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 Lesser General Public License for more details. + +You should have received a copy of the GNU Lesser General Public License +along with this program. If not, see ."; + +@endcond +**/ + +#include +#include +#include +#include +#include + +sexp_cstrwrap_t *init_cstrwrap(const char *src) +{ + sexp_cstrwrap_t *ow = NULL; + + if(!src) { + sexp_errno = SEXP_ERR_NULLSTRING; + return NULL; + } + + ow = (sexp_cstrwrap_t *)sexp_calloc(1, sizeof(sexp_cstrwrap_t)); + + if(!ow) { + sexp_errno = SEXP_ERR_MEMORY; + return NULL; + } + + memset(ow, 0, sizeof(sexp_cstrwrap_t)); + ow->seval = src; + ow->sln = strlen(src); + + return ow; +} + +void destroy_cstrwrap(sexp_cstrwrap_t *csw) +{ + if(!csw) return; + + if(csw->cc) destroy_continuation(csw->cc); + sexp_free(csw, sizeof(sexp_cstrwrap_t)); + + return; +} + +static inline void __rnc_buf(sexp_cstrwrap_t *wr) +{ + int sbuf_size = 0; + + if(wr->sln - wr->cnt >= CSTRBUFSIZ) sbuf_size = CSTRBUFSIZ; + else sbuf_size = wr->sln - wr->cnt; + + /* + * FIXME: is it ugly to copy? + * TODO: way to optimize is to modify a source string + * temproary - it's a way more worse + */ + memcpy(wr->buf, wr->seval + wr->cnt, sbuf_size); + wr->cnt += sbuf_size; + wr->rl = sbuf_size; + + return; +} + +sexp_t *get_one_sexp(sexp_cstrwrap_t *wr) +{ + sexp_t *sx = NULL; + + if(!wr) return NULL; + + /* check for existing leftovers in continuation */ + if(wr->cc && wr->cc->lastPos) { + wr->cc = cparse_sexp(wr->buf, wr->rl, wr->cc); + + if(!wr->cc) return NULL; /* check the errno: it's set here */ + if(wr->cc->last_sexp) { + sx = wr->cc->last_sexp; + wr->cc->last_sexp = NULL; + return sx; + } + wr->rl = 0; + } + + if(wr->rl == 0) { + /* check for EOB */ + if(wr->sln == wr->cnt) { + sexp_errno = SEXP_ERR_OK; + return NULL; /* we're done here */ + } + + __rnc_buf(wr); + } + + wr->cc = cparse_sexp(wr->buf, wr->rl, wr->cc); + + /* if expression more then buf size, read more */ + while(wr->cc->last_sexp == NULL) { + if(wr->cc->error != SEXP_ERR_OK) { + sexp_errno = wr->cc->error; + return NULL; + } + + /* check for EOB */ + if(wr->sln == wr->cnt) { + sexp_errno = SEXP_ERR_IO_EMPTY; + return NULL; /* we're done here, s expression didn't finished */ + } + + __rnc_buf(wr); + + wr->cc = cparse_sexp(wr->buf, wr->rl, wr->cc); + wr->rl = 0; + } + + sx = wr->cc->last_sexp; + wr->cc->last_sexp = NULL; + + return sx; +}