root/libutil/format.h

/* */

INCLUDED FROM

   1 /*
   2  * Copyright (c) 2005, 2006 Tama Communications Corporation
   3  *
   4  * This file is part of GNU GLOBAL.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  * 
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  * 
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19 #ifndef _FORMAT_H_
  20 #define _FORMAT_H_
  21 
  22 /**
  23  * @file
  24  * @par
  25  * (1) @NAME{ctags} -x format (#FORMAT_CTAGS_X)
  26  *
  27  * @par
  28  * @code
  29  * PART_TAG     PART_LNO PART_PATH      PART_LINE
  30  * +----------------------------------------------
  31  * |main             227 ./src/main.c   main()
  32  * @endcode
  33  *
  34  * <br>
  35  * @par
  36  * (2) @NAME{ctags} -x + file id format (#FORMAT_CTAGS_XID)
  37  *
  38  * @par
  39  * @code
  40  * 0    PART_TAG+1 PART_LNO+1 PART_PATH+1   PART_LINE+1
  41  * +----------------------------------------------
  42  * |110 main             227 ./src/main.c   main()
  43  * @endcode
  44  *
  45  * <br>
  46  * @par
  47  * (3) @NAME{ctags} format (#FORMAT_CTAGS)
  48  *
  49  * @par
  50  * @code
  51  * +----------------------------------------------
  52  * |main<TAB>./src/main.c<TAB>227
  53  * @endcode
  54  *
  55  * <br>
  56  * @par
  57  * (4) @NAME{ctags} format (#FORMAT_CTAGS_MOD)
  58  *
  59  * @par
  60  * @code
  61  * +----------------------------------------------
  62  * |./src/main.c<TAB>227<TAB>main()
  63  * @endcode
  64  *
  65  * <br>
  66  * @par
  67  * (5) path name format (#FORMAT_PATH)
  68  *
  69  * @par
  70  * @code
  71  * +----------------------------------------------
  72  * |./src/main.c
  73  * @endcode
  74  *
  75  * <br>
  76  * @par
  77  * (6) @NAME{grep} format (#FORMAT_GREP)
  78  *
  79  * @par
  80  * @code
  81  * +----------------------------------------------
  82  * |./src/main.c:227:main()
  83  * @endcode
  84  *
  85  * <br>
  86  * @par
  87  * (7) @NAME{cscope} line mode format (#FORMAT_CSCOPE)
  88  *
  89  * @par
  90  * @code
  91  * +----------------------------------------------
  92  * |./src/main.c main 227 main()
  93  * @endcode
  94  *
  95  */
  96 #define FORMAT_CTAGS            1
  97 #define FORMAT_CTAGS_X          2
  98 #define FORMAT_CTAGS_XID        3
  99 #define FORMAT_CTAGS_MOD        4
 100 #define FORMAT_PATH             5
 101 #define FORMAT_GREP             6
 102 #define FORMAT_CSCOPE           7
 103 
 104 /**
 105  * @name
 106  * #FORMAT_CTAGS_X
 107  */
 108 /** @{ */
 109 #define PART_TAG  0
 110 #define PART_LNO  1
 111 #define PART_PATH 2
 112 #define PART_LINE 3
 113 /** @} */
 114 
 115 /**
 116  * @name Path name type
 117  */
 118 /** @{ */
 119 #define PATH_RELATIVE   1
 120 #define PATH_ABSOLUTE   2
 121 #define PATH_THROUGH    3
 122 #define PATH_SHORTER    4
 123 #define PATH_ABSLIB     5
 124 /** @} */
 125 
 126 #endif /* ! _FORMAT_H_ */

/* */