/*===========================================================================
 Copyright (c) 1998-2000, The Santa Cruz Operation
 All rights reserved.

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are met:

 *Redistributions of source code must retain the above copyright notice,
 this list of conditions and the following disclaimer.

 *Redistributions in binary form must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.

 *Neither name of The Santa Cruz Operation nor the names of its contributors
 may be used to endorse or promote products derived from this software
 without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS
 IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT falseT LIMITED TO,
 THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE
 LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 CONSEQUENTIAL DAMAGES (INCLUDING, BUT falseT LIMITED TO, PROCUREMENT OF
 SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 INTERRUPTION)
 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 DAMAGE.
 =========================================================================*/

/*    cscope - interactive C symbol cross-reference
 *
 *    preprocessor macro and constant definitions
 */

#ifndef CSCOPE_CONSTANTS_H
#define CSCOPE_CONSTANTS_H

#define ctrl(x) (x & 037) /* control character macro */

/* fast string equality tests (avoids most strcmp() calls) */
#define strequal(s1, s2)	(*(s1) == *(s2) && strcmp(s1, s2) == 0)
#define strnotequal(s1, s2) (*(s1) != *(s2) || strcmp(s1, s2) != 0)

/* set the mark character for searching the cross-reference file */
#define setmark(c) (blockmark = c, block[blocklen] = blockmark)

/* get the next character in the cross-reference */
/* note that blockp is assumed not to be null */
#define getrefchar() \
	(*(++blockp + 1) != '\0' ? *blockp : (read_crossreference_block() != NULL ? *blockp : '\0'))

/* skip the next character in the cross-reference */
/* note that blockp is assumed not to be null and that
   this macro will always be in a statement by itself */
#define skiprefchar() \
	if(*(++blockp + 1) == '\0') (void)read_crossreference_block()

#define DUMMYCHAR	   ' '			   /* use space as a dummy character */
#define MSGLEN		   ((PATLEN) + 80) /* displayed message length */
#define NUMLEN		   10			   /* line number length */
#define PATHLEN		   250			   /* file pathname length */
#define PATLEN		   250			   /* symbol pattern length */
#define TEMPSTRING_LEN 8191			   /* max strlen() of the global temp string */
#define REFFILE		   "cscope.out"	   /* cross-reference output file */
#define NAMEFILE	   "cscope.files"  /* default list-of-files file */
#define INVNAME		   "cscope.in.out" /* inverted index to the database */
#define INVPOST		   "cscope.po.out" /* inverted index postings */
#define INVNAME2	   "cscope.out.in" /* follows correct naming convention */
#define INVPOST2	   "cscope.out.po" /* follows correct naming convention */

#define STMTMAX 10000				   /* maximum source statement length */

/* NOTE: _STRINGIZE ensures that if the argument is a macro,
 *        its expanded before stringinization
 */
#define _STRINGIZE(x) #x
#define STRINGIZE(x)  _STRINGIZE(x)

#define PATLEN_STR         STRINGIZE(PATLEN)
#define PATHLEN_STR        STRINGIZE(PATHLEN)
#define NUMLEN_STR         STRINGIZE(NUMLEN)
#define TEMPSTRING_LEN_STR STRINGIZE(TEMPSTRING_LEN)

/* input fields (value matches field order on screen) */
enum {
	SYMBOL	   = 0,
	DEFINITION = 1,
	CALLEDBY   = 2,
	CALLING	   = 3,
	STRING	   = 4,
	CHANGE	   = 5,
	REGEXP	   = 6,
	FILENAME   = 7,
	INCLUDES   = 8
};

#define FIELDS 10

/* file open modes */
#ifndef R_OK
# define READ R_OK
#else
# define READ 4
#endif

#ifdef W_OK
# define WRITE W_OK
#else
# define WRITE 2
#endif

#define O_TEXT	 0x00
#define O_BINARY 0x00

/* Represents switch cases '0'...'9'.
 * Slightly hacky.
 * Should be use gcc/clang ranges?
 */
#define ASCII_DIGIT '0': \
    case '1': \
    case '2': \
    case '3': \
    case '4': \
    case '5': \
    case '6': \
    case '7': \
    case '8': \
    case '9'

#endif /* CSCOPE_CONSTANTS_H */
