src/troff/charinfo.h

   1 /*@
   2  * Copyright (c) 2014 - 2015 Steffen (Daode) Nurpmeso <sdaoden@users.sf.net>.
   3  *
   4  * Copyright (C) 1989 - 1992, 2001, 2002, 2006
   5  *    Free Software Foundation, Inc.
   6  *      Written by James Clark (jjc@jclark.com)
   7  *
   8  * This is free software; you can redistribute it and/or modify it under
   9  * the terms of the GNU General Public License as published by the Free
  10  * Software Foundation; either version 2, or (at your option) any later
  11  * version.
  12  *
  13  * This is distributed in the hope that it will be useful, but WITHOUT ANY
  14  * WARRANTY; without even the implied warranty of MERCHANTABILITY or
  15  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  16  * for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with groff; see the file COPYING.  If not, write to the Free Software
  20  * Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA.
  21  */
  22 #ifndef _CHARINFO_H
  23 #define _CHARINFO_H
  24
  25 #include "config.h"
  26 #include "troff-config.h"
  27
  28 class macro;
  29
  30 class charinfo
  31 : glyph
  32 {
  33   static int next_index;
  34
  35   charinfo *translation;
  36   macro *mac;
  37   unsigned char special_translation;
  38   unsigned char hyphenation_code;
  39   unsigned char flags;
  40   unsigned char ascii_code;
  41   unsigned char asciify_code;
  42   char not_found;
  43   char transparent_translate;   // non-zero means translation applies
  44                                 // to transparent throughput
  45   char translate_input;         // non-zero means that asciify_code is
  46                                 // active for .asciify (set by .trin)
  47   char_mode mode;
  48
  49 public:
  50   enum {                // Values for the flags bitmask.  See groff
  51                         // manual, description of the `.cflags' request.
  52     ENDS_SENTENCE = 1,
  53     BREAK_BEFORE = 2,
  54     BREAK_AFTER = 4,
  55     OVERLAPS_HORIZONTALLY = 8,
  56     OVERLAPS_VERTICALLY = 16,
  57     TRANSPARENT = 32,
  58     IGNORE_HCODES = 64
  59   };
  60   enum {
  61     TRANSLATE_NONE,
  62     TRANSLATE_SPACE,
  63     TRANSLATE_DUMMY,
  64     TRANSLATE_STRETCHABLE_SPACE,
  65     TRANSLATE_HYPHEN_INDICATOR
  66   };
  67
  68   symbol nm;
  69
  70   charinfo(symbol);
  71   glyph *as_glyph();
  72   int ends_sentence();
  73   int overlaps_vertically();
  74   int overlaps_horizontally();
  75   int can_break_before();
  76   int can_break_after();
  77   int transparent();
  78   int ignore_hcodes();
  79   unsigned char get_hyphenation_code();
  80   unsigned char get_ascii_code();
  81   unsigned char get_asciify_code();
  82   void set_hyphenation_code(unsigned char);
  83   void set_ascii_code(unsigned char);
  84   void set_asciify_code(unsigned char);
  85   void set_translation_input();
  86   int get_translation_input();
  87   charinfo *get_translation(int = 0);
  88   void set_translation(charinfo *, int, int);
  89   void set_flags(unsigned char);
  90   void set_special_translation(int, int);
  91   int get_special_translation(int = 0);
  92   macro *set_macro(macro *);
  93   macro *setx_macro(macro *, char_mode);
  94   macro *get_macro();
  95   int first_time_not_found();
  96   void set_number(int);
  97   int get_number();
  98   int numbered();
  99   int is_normal();
 100   int is_fallback();
 101   int is_special();
 102   symbol *get_symbol();
 103 };
 104
 105 charinfo *get_charinfo(symbol);
 106 extern charinfo *charset_table[];
 107 charinfo *get_charinfo_by_number(int);
 108
 109 inline int charinfo::overlaps_horizontally()
 110 {
 111   return flags & OVERLAPS_HORIZONTALLY;
 112 }
 113
 114 inline int charinfo::overlaps_vertically()
 115 {
 116   return flags & OVERLAPS_VERTICALLY;
 117 }
 118
 119 inline int charinfo::can_break_before()
 120 {
 121   return flags & BREAK_BEFORE;
 122 }
 123
 124 inline int charinfo::can_break_after()
 125 {
 126   return flags & BREAK_AFTER;
 127 }
 128
 129 inline int charinfo::ends_sentence()
 130 {
 131   return flags & ENDS_SENTENCE;
 132 }
 133
 134 inline int charinfo::transparent()
 135 {
 136   return flags & TRANSPARENT;
 137 }
 138
 139 inline int charinfo::ignore_hcodes()
 140 {
 141   return flags & IGNORE_HCODES;
 142 }
 143
 144 inline int charinfo::numbered()
 145 {
 146   return number >= 0;
 147 }
 148
 149 inline int charinfo::is_normal()
 150 {
 151   return mode == CHAR_NORMAL;
 152 }
 153
 154 inline int charinfo::is_fallback()
 155 {
 156   return mode == CHAR_FALLBACK;
 157 }
 158
 159 inline int charinfo::is_special()
 160 {
 161   return mode == CHAR_SPECIAL;
 162 }
 163
 164 inline charinfo *charinfo::get_translation(int transparent_throughput)
 165 {
 166   return (transparent_throughput && !transparent_translate
 167           ? 0
 168           : translation);
 169 }
 170
 171 inline unsigned char charinfo::get_hyphenation_code()
 172 {
 173   return hyphenation_code;
 174 }
 175
 176 inline unsigned char charinfo::get_ascii_code()
 177 {
 178   return ascii_code;
 179 }
 180
 181 inline unsigned char charinfo::get_asciify_code()
 182 {
 183   return (translate_input ? asciify_code : 0);
 184 }
 185
 186 inline void charinfo::set_flags(unsigned char c)
 187 {
 188   flags = c;
 189 }
 190
 191 inline glyph *charinfo::as_glyph()
 192 {
 193   return this;
 194 }
 195
 196 inline void charinfo::set_translation_input()
 197 {
 198   translate_input = 1;
 199 }
 200
 201 inline int charinfo::get_translation_input()
 202 {
 203   return translate_input;
 204 }
 205
 206 inline int charinfo::get_special_translation(int transparent_throughput)
 207 {
 208   return (transparent_throughput && !transparent_translate
 209           ? int(TRANSLATE_NONE)
 210           : special_translation);
 211 }
 212
 213 inline macro *charinfo::get_macro()
 214 {
 215   return mac;
 216 }
 217
 218 inline int charinfo::first_time_not_found()
 219 {
 220   if (not_found)
 221     return 0;
 222   else {
 223     not_found = 1;
 224     return 1;
 225   }
 226 }
 227
 228 inline symbol *charinfo::get_symbol()
 229 {
 230   return( &nm );
 231 }
 232
 233 #endif // _CHARINFO_H
 234 // s-it2-mode