summaryrefslogtreecommitdiff
path: root/Build/source/texk/kpathsea/lib.h
diff options
context:
space:
mode:
Diffstat (limited to 'Build/source/texk/kpathsea/lib.h')
-rw-r--r--Build/source/texk/kpathsea/lib.h235
1 files changed, 235 insertions, 0 deletions
diff --git a/Build/source/texk/kpathsea/lib.h b/Build/source/texk/kpathsea/lib.h
new file mode 100644
index 00000000000..9255834ce29
--- /dev/null
+++ b/Build/source/texk/kpathsea/lib.h
@@ -0,0 +1,235 @@
+/* lib.h: declarations for common, low-level routines in kpathsea.
+
+ Copyright 1992, 1993, 1994, 1995, 1996, 2008, 2009, 2010, 2011,
+ 2012, 2015 Karl Berry.
+ Copyright 1999, 2000, 2003, 2005 Olaf Weber.
+
+ This library 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 library 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 library; if not, see <http://www.gnu.org/licenses/>. */
+
+#ifndef KPATHSEA_LIB_H
+#define KPATHSEA_LIB_H
+
+#include <kpathsea/c-proto.h>
+#include <kpathsea/systypes.h>
+#include <kpathsea/types.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/* Define common sorts of messages. */
+
+/* This should be called only after a system call fails. Don't exit
+ with status `errno', because that might be 256, which would mean
+ success (exit statuses are truncated to eight bits). */
+
+#if defined (KPSE_COMPAT_API)
+/* This branch works as expected also in programs that use the new interface,
+ because kpathsea_set_program_name() sets up the kpse_def->invocation_name
+ whenever it is available.
+*/
+#define FATAL_PERROR(str) do { \
+ fprintf (stderr, "%s: ", kpse_def->invocation_name); \
+ perror (str); exit (EXIT_FAILURE); } while (0)
+#else
+/* If there is no global variable available, just output the error */
+#define FATAL_PERROR(str) do { \
+ perror (str); exit (EXIT_FAILURE); } while (0)
+#endif
+
+#if defined (KPSE_COMPAT_API)
+#define START_FATAL() do { \
+ fprintf (stderr, "%s: fatal: ", kpse_def->invocation_name);
+#else
+#define START_FATAL() do { \
+ fprintf (stderr, "fatal: ");
+#endif
+
+#define END_FATAL() fputs (".\n", stderr); exit (1); } while (0)
+
+#define FATAL(str) \
+ START_FATAL (); fputs (str, stderr); END_FATAL ()
+#define FATAL1(str, e1) \
+ START_FATAL (); fprintf (stderr, str, e1); END_FATAL ()
+#define FATAL2(str, e1, e2) \
+ START_FATAL (); fprintf (stderr, str, e1, e2); END_FATAL ()
+#define FATAL3(str, e1, e2, e3) \
+ START_FATAL (); fprintf (stderr, str, e1, e2, e3); END_FATAL ()
+#define FATAL4(str, e1, e2, e3, e4) \
+ START_FATAL (); fprintf (stderr, str, e1, e2, e3, e4); END_FATAL ()
+#define FATAL5(str, e1, e2, e3, e4, e5) \
+ START_FATAL (); fprintf (stderr, str, e1, e2, e3, e4, e5); END_FATAL ()
+#define FATAL6(str, e1, e2, e3, e4, e5, e6) \
+ START_FATAL (); fprintf (stderr, str, e1, e2, e3, e4, e5, e6); END_FATAL ()
+
+#define START_WARNING() do { fputs ("warning: ", stderr)
+#define END_WARNING() fputs (".\n", stderr); fflush (stderr); } while (0)
+
+#define WARNING(str) \
+ START_WARNING (); fputs (str, stderr); END_WARNING ()
+#define WARNING1(str, e1) \
+ START_WARNING (); fprintf (stderr, str, e1); END_WARNING ()
+#define WARNING2(str, e1, e2) \
+ START_WARNING (); fprintf (stderr, str, e1, e2); END_WARNING ()
+#define WARNING3(str, e1, e2, e3) \
+ START_WARNING (); fprintf (stderr, str, e1, e2, e3); END_WARNING ()
+#define WARNING4(str, e1, e2, e3, e4) \
+ START_WARNING (); fprintf (stderr, str, e1, e2, e3, e4); END_WARNING ()
+
+/* This requires an identifier `kpse' to be set up correctly. Sorry. */
+#define LIB_START_FATAL() do { \
+ fprintf (stderr, "%s: fatal: ", kpse->invocation_name);
+
+#define LIB_FATAL(str) \
+ LIB_START_FATAL (); fputs (str, stderr); END_FATAL ()
+#define LIB_FATAL1(str, e1) \
+ LIB_START_FATAL (); fprintf (stderr, str, e1); END_FATAL ()
+#define LIB_FATAL2(str, e1, e2) \
+ LIB_START_FATAL (); fprintf (stderr, str, e1, e2); END_FATAL ()
+
+
+/* I find this easier to read. */
+#define STREQ(s1, s2) (((s1) != NULL) && ((s2) != NULL) && (strcmp (s1, s2) == 0))
+#define STRNEQ(s1, s2, n) ((s1) && (s2) && (strncmp (s1, s2, n) == 0))
+
+/* Support for FAT/ISO-9660 filesystems. Theoretically this should be
+ done at runtime, per filesystem, but that's painful to program. */
+#ifdef MONOCASE_FILENAMES
+#define FILESTRCASEEQ(s1,s2) ((s1) && (s2) && (strcasecmp (s1, s2) == 0))
+#define FILESTRNCASEEQ(s1,s2,l) ((s1) && (s2) && (strncasecmp (s1,s2,l) == 0))
+#define FILECHARCASEEQ(c1,c2) (toupper (c1) == toupper (c2))
+#else
+#define FILESTRCASEEQ STREQ
+#define FILESTRNCASEEQ STRNEQ
+#define FILECHARCASEEQ(c1,c2) ((c1) == (c2))
+#endif
+
+/* This is the maximum number of numerals that result when a 64-bit
+ integer is converted to a string, plus one for a trailing null byte,
+ plus one for a sign. */
+#define MAX_INT_LENGTH 21
+
+/* If the environment variable TEST is set, return it; otherwise,
+ DEFAULT. This is useful for paths that use more than one envvar. */
+#define ENVVAR(test, default) (getenv (test) ? (test) : (default))
+
+/* Return whether a kpse configuration is (some sort of) true. Check
+ for negation values, so a value like "2" will be true, just in case. */
+#define KPSE_CNF_P(val) \
+ ((val) && *(val) && *(val) != 'f' && *(val) != '0')
+
+
+/* Return a fresh copy of S1 followed by S2, et al. */
+extern KPSEDLL string concat (const_string s1, const_string s2);
+extern KPSEDLL string concat3 (const_string, const_string, const_string);
+/* `concatn' is declared in its own include file, to avoid pulling in
+ all the varargs stuff. */
+
+/* A fresh copy of just S. */
+extern KPSEDLL string xstrdup (const_string s);
+
+/* Convert all lowercase characters in S to uppercase. */
+extern KPSEDLL string uppercasify (const_string s);
+
+/* Like `atoi', but disallow negative numbers. */
+extern KPSEDLL unsigned atou (const_string);
+
+/* True if FILENAME1 and FILENAME2 are the same file. If stat fails on
+ either name, return false, no error message.
+ Cf. `SAME_FILE_P' in xstat.h. */
+extern KPSEDLL boolean same_file_p (const_string filename1,
+ const_string filename2);
+
+/* Return NAME with any leading path stripped off. This returns a
+ pointer into NAME. */
+extern KPSEDLL const_string xbasename (const_string name);
+
+/* Return directory part of NAME. This returns a new string. */
+extern KPSEDLL string xdirname (const_string name);
+
+/* If NAME has a suffix, return a pointer to its first character (i.e.,
+ the one after the `.'); otherwise, return NULL. */
+extern KPSEDLL const_string find_suffix (const_string name);
+
+/* Return NAME with any suffix removed. */
+extern KPSEDLL string remove_suffix (const_string name);
+
+/* Return S with the suffix SUFFIX, removing any suffix already present.
+ For example, `make_suffix ("/foo/bar.baz", "quux")' returns
+ `/foo/bar.quux'. Returns a string allocated with malloc. */
+extern KPSEDLL string make_suffix (const_string s, const_string suffix);
+
+/* Return NAME with STEM_PREFIX prepended to the stem. For example,
+ `make_prefix ("/foo/bar.baz", "x")' returns `/foo/xbar.baz'.
+ Returns a string allocated with malloc. */
+extern KPSEDLL string make_prefix (string stem_prefix, string name);
+
+/* If NAME has a suffix, simply return it; otherwise, return
+ `NAME.SUFFIX'. */
+extern KPSEDLL const_string extend_filename (const_string name,
+ const_string suffix);
+
+/* Call putenv with the string `VAR=VALUE' and abort on error. */
+extern KPSEDLL void kpathsea_xputenv (kpathsea kpse, const_string var,
+ const_string value);
+extern KPSEDLL void kpathsea_xputenv_int (kpathsea kpse, const_string var,
+ int value);
+#if defined (KPSE_COMPAT_API)
+extern KPSEDLL void xputenv (const_string var, const_string value);
+extern KPSEDLL void xputenv_int (const_string var, int value);
+#endif
+
+/* Return the current working directory. */
+extern KPSEDLL string xgetcwd (void);
+
+/* Returns true if FN is a directory or a symlink to a directory. */
+extern KPSEDLL boolean kpathsea_dir_p (kpathsea kpse, string fn);
+#if defined (KPSE_COMPAT_API)
+extern KPSEDLL boolean dir_p (string fn);
+#endif
+
+/* If FN is a readable directory, return the number of links it has.
+ Otherwise, return -1. The nlinks parameter is a dummy on UNIX. */
+#if defined (KPSE_COMPAT_API)
+extern KPSEDLL int dir_links (const_string fn, long nlinks);
+#endif
+extern KPSEDLL int kpathsea_dir_links (kpathsea kpse, const_string fn,
+ long nlinks);
+
+/* Like their stdio counterparts, but abort on error, after calling
+ perror(3) with FILENAME as its argument. */
+extern KPSEDLL FILE *xfopen (const_string filename, const_string mode);
+extern KPSEDLL void xfclose (FILE *fp, const_string filename);
+extern KPSEDLL void xfseek (FILE *fp, long offset, int wherefrom, const_string filename);
+extern KPSEDLL void xfseeko (FILE *fp, off_t offset, int wherefrom, const_string filename);
+extern KPSEDLL long xftell (FILE *fp, const_string filename);
+extern KPSEDLL off_t xftello (FILE *fp, const_string filename);
+
+/* These call the corresponding function in the standard library, and
+ abort if those routines fail. Also, `xrealloc' calls `xmalloc' if
+ OLD_ADDRESS is null. */
+extern KPSEDLL address xmalloc (size_t size);
+extern KPSEDLL address xrealloc (address old_address, size_t new_size);
+extern KPSEDLL address xcalloc (size_t nelem, size_t elsize);
+
+/* (Re)Allocate N items of type T using xmalloc/xrealloc. */
+#define XTALLOC(n, t) ((t *) xmalloc ((n) * sizeof (t)))
+#define XTALLOC1(t) XTALLOC (1, t)
+#define XRETALLOC(addr, n, t) ((addr) = (t *) xrealloc (addr, (n) * sizeof(t)))
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* not KPATHSEA_LIB_H */