icuSources/common/rbbirb.cpp

   1 //
   2 //  file:  rbbirb.cpp
   3 //
   4 //  Copyright (C) 2002-2011, International Business Machines Corporation and others.
   5 //  All Rights Reserved.
   6 //
   7 //  This file contains the RBBIRuleBuilder class implementation.  This is the main class for
   8 //    building (compiling) break rules into the tables required by the runtime
   9 //    RBBI engine.
  10 //
  11
  12 #include "unicode/utypes.h"
  13
  14 #if !UCONFIG_NO_BREAK_ITERATION
  15
  16 #include "unicode/brkiter.h"
  17 #include "unicode/rbbi.h"
  18 #include "unicode/ubrk.h"
  19 #include "unicode/unistr.h"
  20 #include "unicode/uniset.h"
  21 #include "unicode/uchar.h"
  22 #include "unicode/uchriter.h"
  23 #include "unicode/parsepos.h"
  24 #include "unicode/parseerr.h"
  25 #include "cmemory.h"
  26 #include "cstring.h"
  27
  28 #include "rbbirb.h"
  29 #include "rbbinode.h"
  30
  31 #include "rbbiscan.h"
  32 #include "rbbisetb.h"
  33 #include "rbbitblb.h"
  34 #include "rbbidata.h"
  35
  36
  37 U_NAMESPACE_BEGIN
  38
  39
  40 //----------------------------------------------------------------------------------------
  41 //
  42 //  Constructor.
  43 //
  44 //----------------------------------------------------------------------------------------
  45 RBBIRuleBuilder::RBBIRuleBuilder(const UnicodeString   &rules,
  46                                        UParseError     *parseErr,
  47                                        UErrorCode      &status)
  48  : fRules(rules)
  49 {
  50     fStatus = &status; // status is checked below
  51     fParseError = parseErr;
  52     fDebugEnv   = NULL;
  53 #ifdef RBBI_DEBUG
  54     fDebugEnv   = getenv("U_RBBIDEBUG");
  55 #endif
  56
  57
  58     fForwardTree        = NULL;
  59     fReverseTree        = NULL;
  60     fSafeFwdTree        = NULL;
  61     fSafeRevTree        = NULL;
  62     fDefaultTree        = &fForwardTree;
  63     fForwardTables      = NULL;
  64     fReverseTables      = NULL;
  65     fSafeFwdTables      = NULL;
  66     fSafeRevTables      = NULL;
  67     fRuleStatusVals     = NULL;
  68     fChainRules         = FALSE;
  69     fLBCMNoChain        = FALSE;
  70     fLookAheadHardBreak = FALSE;
  71     fRINoChain          = FALSE;
  72     fUSetNodes          = NULL;
  73     fRuleStatusVals     = NULL;
  74     fScanner            = NULL;
  75     fSetBuilder         = NULL;
  76     if (parseErr) {
  77         uprv_memset(parseErr, 0, sizeof(UParseError));
  78     }
  79
  80     if (U_FAILURE(status)) {
  81         return;
  82     }
  83
  84     fUSetNodes          = new UVector(status); // bcos status gets overwritten here
  85     fRuleStatusVals     = new UVector(status);
  86     fScanner            = new RBBIRuleScanner(this);
  87     fSetBuilder         = new RBBISetBuilder(this);
  88     if (U_FAILURE(status)) {
  89         return;
  90     }
  91     if(fSetBuilder == 0 || fScanner == 0 || fUSetNodes == 0 || fRuleStatusVals == 0) {
  92         status = U_MEMORY_ALLOCATION_ERROR;
  93     }
  94 }
  95
  96
  97
  98 //----------------------------------------------------------------------------------------
  99 //
 100 //  Destructor
 101 //
 102 //----------------------------------------------------------------------------------------
 103 RBBIRuleBuilder::~RBBIRuleBuilder() {
 104
 105     int        i;
 106     for (i=0; ; i++) {
 107         RBBINode *n = (RBBINode *)fUSetNodes->elementAt(i);
 108         if (n==NULL) {
 109             break;
 110         }
 111         delete n;
 112     }
 113
 114     delete fUSetNodes;
 115     delete fSetBuilder;
 116     delete fForwardTables;
 117     delete fReverseTables;
 118     delete fSafeFwdTables;
 119     delete fSafeRevTables;
 120
 121     delete fForwardTree;
 122     delete fReverseTree;
 123     delete fSafeFwdTree;
 124     delete fSafeRevTree;
 125     delete fScanner;
 126     delete fRuleStatusVals;
 127 }
 128
 129
 130
 131
 132
 133 //----------------------------------------------------------------------------------------
 134 //
 135 //   flattenData() -  Collect up the compiled RBBI rule data and put it into
 136 //                    the format for saving in ICU data files,
 137 //                    which is also the format needed by the RBBI runtime engine.
 138 //
 139 //----------------------------------------------------------------------------------------
 140 static int32_t align8(int32_t i) {return (i+7) & 0xfffffff8;}
 141
 142 RBBIDataHeader *RBBIRuleBuilder::flattenData() {
 143     int32_t    i;
 144
 145     if (U_FAILURE(*fStatus)) {
 146         return NULL;
 147     }
 148
 149     // Remove comments and whitespace from the rules to make it smaller.
 150     UnicodeString strippedRules((const UnicodeString&)RBBIRuleScanner::stripRules(fRules));
 151
 152     // Calculate the size of each section in the data.
 153     //   Sizes here are padded up to a multiple of 8 for better memory alignment.
 154     //   Sections sizes actually stored in the header are for the actual data
 155     //     without the padding.
 156     //
 157     int32_t headerSize        = align8(sizeof(RBBIDataHeader));
 158     int32_t forwardTableSize  = align8(fForwardTables->getTableSize());
 159     int32_t reverseTableSize  = align8(fReverseTables->getTableSize());
 160     int32_t safeFwdTableSize  = align8(fSafeFwdTables->getTableSize());
 161     int32_t safeRevTableSize  = align8(fSafeRevTables->getTableSize());
 162     int32_t trieSize          = align8(fSetBuilder->getTrieSize());
 163     int32_t statusTableSize   = align8(fRuleStatusVals->size() * sizeof(int32_t));
 164     int32_t rulesSize         = align8((strippedRules.length()+1) * sizeof(UChar));
 165
 166     int32_t         totalSize = headerSize + forwardTableSize + reverseTableSize
 167                                 + safeFwdTableSize + safeRevTableSize
 168                                 + statusTableSize + trieSize + rulesSize;
 169
 170     RBBIDataHeader  *data     = (RBBIDataHeader *)uprv_malloc(totalSize);
 171     if (data == NULL) {
 172         *fStatus = U_MEMORY_ALLOCATION_ERROR;
 173         return NULL;
 174     }
 175     uprv_memset(data, 0, totalSize);
 176
 177
 178     data->fMagic            = 0xb1a0;
 179     data->fFormatVersion[0] = 3;
 180     data->fFormatVersion[1] = 1;
 181     data->fFormatVersion[2] = 0;
 182     data->fFormatVersion[3] = 0;
 183     data->fLength           = totalSize;
 184     data->fCatCount         = fSetBuilder->getNumCharCategories();
 185
 186     data->fFTable        = headerSize;
 187     data->fFTableLen     = forwardTableSize;
 188     data->fRTable        = data->fFTable  + forwardTableSize;
 189     data->fRTableLen     = reverseTableSize;
 190     data->fSFTable       = data->fRTable  + reverseTableSize;
 191     data->fSFTableLen    = safeFwdTableSize;
 192     data->fSRTable       = data->fSFTable + safeFwdTableSize;
 193     data->fSRTableLen    = safeRevTableSize;
 194
 195     data->fTrie          = data->fSRTable + safeRevTableSize;
 196     data->fTrieLen       = fSetBuilder->getTrieSize();
 197     data->fStatusTable   = data->fTrie    + trieSize;
 198     data->fStatusTableLen= statusTableSize;
 199     data->fRuleSource    = data->fStatusTable + statusTableSize;
 200     data->fRuleSourceLen = strippedRules.length() * sizeof(UChar);
 201
 202     uprv_memset(data->fReserved, 0, sizeof(data->fReserved));
 203
 204     fForwardTables->exportTable((uint8_t *)data + data->fFTable);
 205     fReverseTables->exportTable((uint8_t *)data + data->fRTable);
 206     fSafeFwdTables->exportTable((uint8_t *)data + data->fSFTable);
 207     fSafeRevTables->exportTable((uint8_t *)data + data->fSRTable);
 208     fSetBuilder->serializeTrie ((uint8_t *)data + data->fTrie);
 209
 210     int32_t *ruleStatusTable = (int32_t *)((uint8_t *)data + data->fStatusTable);
 211     for (i=0; i<fRuleStatusVals->size(); i++) {
 212         ruleStatusTable[i] = fRuleStatusVals->elementAti(i);
 213     }
 214
 215     strippedRules.extract((UChar *)((uint8_t *)data+data->fRuleSource), rulesSize/2+1, *fStatus);
 216
 217     return data;
 218 }
 219
 220
 221
 222
 223
 224
 225 //----------------------------------------------------------------------------------------
 226 //
 227 //  createRuleBasedBreakIterator    construct from source rules that are passed in
 228 //                                  in a UnicodeString
 229 //
 230 //----------------------------------------------------------------------------------------
 231 BreakIterator *
 232 RBBIRuleBuilder::createRuleBasedBreakIterator( const UnicodeString    &rules,
 233                                     UParseError      *parseError,
 234                                     UErrorCode       &status)
 235 {
 236     // status checked below
 237
 238     //
 239     // Read the input rules, generate a parse tree, symbol table,
 240     // and list of all Unicode Sets referenced by the rules.
 241     //
 242     RBBIRuleBuilder  builder(rules, parseError, status);
 243     if (U_FAILURE(status)) { // status checked here bcos build below doesn't
 244         return NULL;
 245     }
 246     builder.fScanner->parse();
 247
 248     //
 249     // UnicodeSet processing.
 250     //    Munge the Unicode Sets to create a set of character categories.
 251     //    Generate the mapping tables (TRIE) from input 32-bit characters to
 252     //    the character categories.
 253     //
 254     builder.fSetBuilder->build();
 255
 256
 257     //
 258     //   Generate the DFA state transition table.
 259     //
 260     builder.fForwardTables = new RBBITableBuilder(&builder, &builder.fForwardTree);
 261     builder.fReverseTables = new RBBITableBuilder(&builder, &builder.fReverseTree);
 262     builder.fSafeFwdTables = new RBBITableBuilder(&builder, &builder.fSafeFwdTree);
 263     builder.fSafeRevTables = new RBBITableBuilder(&builder, &builder.fSafeRevTree);
 264     if (builder.fForwardTables == NULL || builder.fReverseTables == NULL ||
 265         builder.fSafeFwdTables == NULL || builder.fSafeRevTables == NULL)
 266     {
 267         status = U_MEMORY_ALLOCATION_ERROR;
 268         delete builder.fForwardTables; builder.fForwardTables = NULL;
 269         delete builder.fReverseTables; builder.fReverseTables = NULL;
 270         delete builder.fSafeFwdTables; builder.fSafeFwdTables = NULL;
 271         delete builder.fSafeRevTables; builder.fSafeRevTables = NULL;
 272         return NULL;
 273     }
 274
 275     builder.fForwardTables->build();
 276     builder.fReverseTables->build();
 277     builder.fSafeFwdTables->build();
 278     builder.fSafeRevTables->build();
 279
 280 #ifdef RBBI_DEBUG
 281     if (builder.fDebugEnv && uprv_strstr(builder.fDebugEnv, "states")) {
 282         builder.fForwardTables->printRuleStatusTable();
 283     }
 284 #endif
 285
 286     //
 287     //   Package up the compiled data into a memory image
 288     //      in the run-time format.
 289     //
 290     RBBIDataHeader *data = builder.flattenData(); // returns NULL if error
 291     if (U_FAILURE(*builder.fStatus)) {
 292         return NULL;
 293     }
 294
 295
 296     //
 297     //  Clean up the compiler related stuff
 298     //
 299
 300
 301     //
 302     //  Create a break iterator from the compiled rules.
 303     //     (Identical to creation from stored pre-compiled rules)
 304     //
 305     // status is checked after init in construction.
 306     RuleBasedBreakIterator *This = new RuleBasedBreakIterator(data, status);
 307     if (U_FAILURE(status)) {
 308         delete This;
 309         This = NULL;
 310     }
 311     else if(This == NULL) { // test for NULL
 312         status = U_MEMORY_ALLOCATION_ERROR;
 313     }
 314     return This;
 315 }
 316
 317 U_NAMESPACE_END
 318
 319 #endif /* #if !UCONFIG_NO_BREAK_ITERATION */