sc/inc/compiler.hxx

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: compiler.hxx,v $
  10  * $Revision: 1.36.30.4 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef SC_COMPILER_HXX
  32 #define SC_COMPILER_HXX
  33
  34 #ifndef INCLUDED_STRING_H
  35 #include <string.h>
  36 #define INCLUDED_STRING_H
  37 #endif
  38 #include <tools/mempool.hxx>
  39 #include "scdllapi.h"
  40 #include "global.hxx"
  41 #include "refdata.hxx"
  42 #include "formula/token.hxx"
  43 #include "formula/intruref.hxx"
  44 #include "formula/grammar.hxx"
  45 #include <unotools/charclass.hxx>
  46 #include <rtl/ustrbuf.hxx>
  47 #include <com/sun/star/sheet/ExternalLinkInfo.hpp>
  48 #include <vector>
  49
  50 #include <formula/FormulaCompiler.hxx>
  51
  52
  53 #ifndef BOOST_SHARED_PTR_HPP_INCLUDED
  54 #include <boost/shared_ptr.hpp>
  55 #endif
  56
  57 #ifndef INCLUDED_HASH_MAP
  58 #include <hash_map>
  59 #define INCLUDED_HASH_MAP
  60 #endif
  61
  62 //-----------------------------------------------
  63
  64 // constants and data types also for external modules (ScInterpreter et al)
  65
  66 #define MAXCODE      512    /* maximum number of tokens in formula */
  67 #define MAXSTRLEN    256    /* maximum length of input string of one symbol */
  68 #define MAXJUMPCOUNT 32     /* maximum number of jumps (ocChose) */
  69
  70 // flag values of CharTable
  71 #define SC_COMPILER_C_ILLEGAL         0x00000000
  72 #define SC_COMPILER_C_CHAR            0x00000001
  73 #define SC_COMPILER_C_CHAR_BOOL       0x00000002
  74 #define SC_COMPILER_C_CHAR_WORD       0x00000004
  75 #define SC_COMPILER_C_CHAR_VALUE      0x00000008
  76 #define SC_COMPILER_C_CHAR_STRING     0x00000010
  77 #define SC_COMPILER_C_CHAR_DONTCARE   0x00000020
  78 #define SC_COMPILER_C_BOOL            0x00000040
  79 #define SC_COMPILER_C_WORD            0x00000080
  80 #define SC_COMPILER_C_WORD_SEP        0x00000100
  81 #define SC_COMPILER_C_VALUE           0x00000200
  82 #define SC_COMPILER_C_VALUE_SEP       0x00000400
  83 #define SC_COMPILER_C_VALUE_EXP       0x00000800
  84 #define SC_COMPILER_C_VALUE_SIGN      0x00001000
  85 #define SC_COMPILER_C_VALUE_VALUE     0x00002000
  86 #define SC_COMPILER_C_STRING_SEP      0x00004000
  87 #define SC_COMPILER_C_NAME_SEP        0x00008000  // there can be only one! '\''
  88 #define SC_COMPILER_C_CHAR_IDENT      0x00010000  // identifier (built-in function) or reference start
  89 #define SC_COMPILER_C_IDENT           0x00020000  // identifier or reference continuation
  90 #define SC_COMPILER_C_ODF_LBRACKET    0x00040000  // ODF '[' reference bracket
  91 #define SC_COMPILER_C_ODF_RBRACKET    0x00080000  // ODF ']' reference bracket
  92 #define SC_COMPILER_C_ODF_LABEL_OP    0x00100000  // ODF '!!' automatic intersection of labels
  93 #define SC_COMPILER_C_ODF_NAME_MARKER 0x00200000  // ODF '$$' marker that starts a defined (range) name
  94
  95 #define SC_COMPILER_FILE_TAB_SEP      '#'         // 'Doc'#Tab
  96
  97
  98 class ScDocument;
  99 class ScMatrix;
 100 class ScRangeData;
 101 class ScExternalRefManager;
 102 class ScTokenArray;
 103
 104 // constants and data types internal to compiler
 105
 106 #if 0
 107 /*
 108     OpCode   eOp;           // OpCode
 109     formula::StackVar eType;         // type of data
 110     USHORT   nRefCnt;       // reference count
 111     BOOL     bRaw;          // not cloned yet and trimmed to real size
 112  */
 113 #endif
 114
 115 #define SC_TOKEN_FIX_MEMBERS    \
 116     OpCode   eOp;               \
 117     formula::StackVar eType;    \
 118     USHORT   nRefCnt;           \
 119     BOOL     bRaw;
 120
 121 struct ScDoubleRawToken
 122 {
 123 private:
 124     SC_TOKEN_FIX_MEMBERS
 125 public:
 126     union
 127     {   // union only to assure alignment identical to ScRawToken
 128         double      nValue;
 129         struct {
 130             BYTE        cByte;
 131             bool        bHasForceArray;
 132         } sbyte;
 133     };
 134                 DECL_FIXEDMEMPOOL_NEWDEL( ScDoubleRawToken );
 135 };
 136
 137 struct ScRawToken
 138 {
 139     friend class ScCompiler;
 140     // Friends that use a temporary ScRawToken on the stack (and therefor need
 141     // the private dtor) and know what they're doing..
 142     friend class ScTokenArray;
 143     friend USHORT lcl_ScRawTokenOffset();
 144 private:
 145     SC_TOKEN_FIX_MEMBERS
 146 public:
 147     union {
 148         double       nValue;
 149         struct {
 150             BYTE        cByte;
 151             bool        bHasForceArray;
 152         } sbyte;
 153         ScComplexRefData aRef;
 154         struct {
 155             sal_uInt16      nFileId;
 156             sal_Unicode     cTabName[MAXSTRLEN+1];
 157             ScComplexRefData    aRef;
 158         } extref;
 159         struct {
 160             sal_uInt16  nFileId;
 161             sal_Unicode cName[MAXSTRLEN+1];
 162         } extname;
 163         ScMatrix*    pMat;
 164         USHORT       nIndex;                // index into name collection
 165         sal_Unicode  cStr[ MAXSTRLEN+1 ];   // string (up to 255 characters + 0)
 166         short        nJump[MAXJUMPCOUNT+1]; // If/Chose token
 167     };
 168
 169                 //! other members not initialized
 170                 ScRawToken() : bRaw( TRUE ) {}
 171 private:
 172                 ~ScRawToken() {}                //! only delete via Delete()
 173 public:
 174                 DECL_FIXEDMEMPOOL_NEWDEL( ScRawToken );
 175     formula::StackVar    GetType()   const       { return (formula::StackVar) eType; }
 176     OpCode      GetOpCode() const       { return (OpCode)   eOp;   }
 177     void        NewOpCode( OpCode e )   { eOp = e; }
 178     void        IncRef()                { nRefCnt++;       }
 179     void        DecRef()                { if( !--nRefCnt ) Delete(); }
 180     USHORT      GetRef() const          { return nRefCnt; }
 181     SC_DLLPUBLIC void       Delete();
 182
 183     // Use these methods only on tokens that are not part of a token array,
 184     // since the reference count is cleared!
 185     void SetOpCode( OpCode eCode );
 186     void SetString( const sal_Unicode* pStr );
 187     void SetSingleReference( const ScSingleRefData& rRef );
 188     void SetDoubleReference( const ScComplexRefData& rRef );
 189     void SetDouble( double fVal );
 190 //UNUSED2008-05  void SetInt( int nVal );
 191 //UNUSED2008-05  void SetMatrix( ScMatrix* p );
 192
 193     // These methods are ok to use, reference count not cleared.
 194 //UNUSED2008-05  ScComplexRefData& GetReference();
 195 //UNUSED2008-05  void SetReference( ScComplexRefData& rRef );
 196     void SetName( USHORT n );
 197     void SetExternalSingleRef( sal_uInt16 nFileId, const String& rTabName, const ScSingleRefData& rRef );
 198     void SetExternalDoubleRef( sal_uInt16 nFileId, const String& rTabName, const ScComplexRefData& rRef );
 199     void SetExternalName( sal_uInt16 nFileId, const String& rName );
 200     void SetMatrix( ScMatrix* p );
 201     void SetExternal(const sal_Unicode* pStr);
 202
 203     ScRawToken* Clone() const;      // real copy!
 204     formula::FormulaToken* CreateToken() const;   // create typified token
 205     void Load( SvStream&, USHORT nVer );
 206
 207     static xub_StrLen GetStrLen( const sal_Unicode* pStr ); // as long as a "string" is an array
 208     static size_t GetStrLenBytes( xub_StrLen nLen )
 209         { return nLen * sizeof(sal_Unicode); }
 210     static size_t GetStrLenBytes( const sal_Unicode* pStr )
 211         { return GetStrLenBytes( GetStrLen( pStr ) ); }
 212 };
 213
 214
 215 typedef formula::SimpleIntrusiveReference< struct ScRawToken > ScRawTokenRef;
 216
 217 class SC_DLLPUBLIC ScCompiler : public formula::FormulaCompiler
 218 {
 219 public:
 220     struct Convention
 221     {
 222         const formula::FormulaGrammar::AddressConvention meConv;
 223         const ULONG*                mpCharTable;
 224
 225
 226         Convention( formula::FormulaGrammar::AddressConvention eConvP );
 227         virtual ~Convention();
 228
 229         virtual void MakeRefStr( rtl::OUStringBuffer&   rBuffer,
 230                                  const ScCompiler&      rCompiler,
 231                                  const ScComplexRefData&    rRef,
 232                                  BOOL bSingleRef ) const = 0;
 233         virtual ::com::sun::star::i18n::ParseResult
 234                     parseAnyToken( const String& rFormula,
 235                                    xub_StrLen nSrcPos,
 236                                    const CharClass* pCharClass) const = 0;
 237
 238         /**
 239          * Parse the symbol string and pick up the file name and the external
 240          * range name.
 241          *
 242          * @return true on successful parse, or false otherwise.
 243          */
 244         virtual bool parseExternalName( const String& rSymbol, String& rFile, String& rName,
 245                 const ScDocument* pDoc,
 246                 const ::com::sun::star::uno::Sequence<
 247                     const ::com::sun::star::sheet::ExternalLinkInfo > * pExternalLinks ) const = 0;
 248
 249         virtual String makeExternalNameStr( const String& rFile, const String& rName ) const = 0;
 250
 251         virtual void makeExternalRefStr( ::rtl::OUStringBuffer& rBuffer, const ScCompiler& rCompiler,
 252                                          sal_uInt16 nFileId, const String& rTabName, const ScSingleRefData& rRef,
 253                                          ScExternalRefManager* pRefMgr ) const = 0;
 254
 255         virtual void makeExternalRefStr( ::rtl::OUStringBuffer& rBuffer, const ScCompiler& rCompiler,
 256                                          sal_uInt16 nFileId, const String& rTabName, const ScComplexRefData& rRef,
 257                                          ScExternalRefManager* pRefMgr ) const = 0;
 258
 259         enum SpecialSymbolType
 260         {
 261             /**
 262              * Character between sheet name and address.  In OOO A1 this is
 263              * '.', while XL A1 and XL R1C1 this is '!'.
 264              */
 265             SHEET_SEPARATOR,
 266
 267             /**
 268              * In OOO A1, a sheet name may be prefixed with '$' to indicate an
 269              * absolute sheet position.
 270              */
 271             ABS_SHEET_PREFIX
 272         };
 273         virtual sal_Unicode getSpecialSymbol( SpecialSymbolType eSymType ) const = 0;
 274     };
 275     friend struct Convention;
 276
 277 private:
 278
 279
 280     static CharClass            *pCharClassEnglish;                      // character classification for en_US locale
 281     static const Convention     *pConventions[ formula::FormulaGrammar::CONV_LAST ];
 282
 283     static const Convention * const pConvOOO_A1;
 284     static const Convention * const pConvOOO_A1_ODF;
 285     static const Convention * const pConvXL_A1;
 286     static const Convention * const pConvXL_R1C1;
 287     static const Convention * const pConvXL_OOX;
 288
 289     static struct AddInMap
 290     {
 291         const char* pODFF;
 292         const char* pEnglish;
 293         bool        bMapDupToInternal;      // when writing ODFF
 294         const char* pOriginal;              // programmatical name
 295         const char* pUpper;                 // upper case programmatical name
 296     } maAddInMap[];
 297     static const AddInMap* GetAddInMap();
 298     static size_t GetAddInMapCount();
 299
 300     ScDocument* pDoc;
 301     ScAddress   aPos;
 302
 303     // For CONV_XL_OOX, may be set via API by MOOXML filter.
 304     ::com::sun::star::uno::Sequence< const ::com::sun::star::sheet::ExternalLinkInfo > maExternalLinks;
 305
 306     sal_Unicode cSymbol[MAXSTRLEN];                 // current Symbol
 307     String      aFormula;                           // formula source code
 308     xub_StrLen  nSrcPos;                            // tokenizer position (source code)
 309     ScRawTokenRef   pRawToken;
 310
 311     const CharClass*    pCharClass;         // which character classification is used for parseAnyToken
 312     USHORT      mnPredetectedReference;     // reference when reading ODF, 0 (none), 1 (single) or 2 (double)
 313     SCsTAB      nMaxTab;                    // last sheet in document
 314     const Convention *pConv;
 315     bool        mbCloseBrackets;            // whether to close open brackets automatically, default TRUE
 316     bool        mbExtendedErrorDetection;
 317
 318     BOOL   NextNewToken(bool bInArray = false);
 319
 320     virtual void SetError(USHORT nError);
 321     xub_StrLen NextSymbol(bool bInArray);
 322     BOOL IsValue( const String& );
 323     BOOL IsOpCode( const String&, bool bInArray );
 324     BOOL IsOpCode2( const String& );
 325     BOOL IsString();
 326     BOOL IsReference( const String& );
 327     BOOL IsSingleReference( const String& );
 328     BOOL IsPredetectedReference( const String& );
 329     BOOL IsDoubleReference( const String& );
 330     BOOL IsMacro( const String& );
 331     BOOL IsNamedRange( const String& );
 332     bool IsExternalNamedRange( const String& rSymbol );
 333     BOOL IsDBRange( const String& );
 334     BOOL IsColRowName( const String& );
 335     BOOL IsBoolean( const String& );
 336     void AutoCorrectParsedSymbol();
 337
 338     void SetRelNameReference();
 339
 340     static void InitCharClassEnglish();
 341
 342 public:
 343     ScCompiler( ScDocument* pDocument, const ScAddress&);
 344
 345     ScCompiler( ScDocument* pDocument, const ScAddress&,ScTokenArray& rArr);
 346
 347 public:
 348     static void DeInit();               /// all
 349
 350     // for ScAddress::Format()
 351     static void CheckTabQuotes( String& aTabName,
 352                                 const formula::FormulaGrammar::AddressConvention eConv = formula::FormulaGrammar::CONV_OOO );
 353
 354     static BOOL EnQuote( String& rStr );
 355
 356     sal_Unicode GetNativeAddressSymbol( Convention::SpecialSymbolType eType ) const;
 357
 358     // Check if it is a valid english function name
 359     bool IsEnglishSymbol( const String& rName );
 360
 361     //! _either_ CompileForFAP _or_ AutoCorrection, _not_ both
 362     // #i101512# SetCompileForFAP is in formula::FormulaCompiler
 363     void            SetAutoCorrection( BOOL bVal )
 364                         { bAutoCorrect = bVal; bIgnoreErrors = bVal; }
 365     void            SetCloseBrackets( bool bVal ) { mbCloseBrackets = bVal; }
 366     void            SetRefConvention( const Convention *pConvP );
 367     void            SetRefConvention( const formula::FormulaGrammar::AddressConvention eConv );
 368
 369     /// Set symbol map if not empty.
 370     void            SetFormulaLanguage( const OpCodeMapPtr & xMap );
 371
 372     void            SetGrammar( const formula::FormulaGrammar::Grammar eGrammar );
 373
 374 private:
 375     /** Set grammar and reference convention from within SetFormulaLanguage()
 376         or SetGrammar().
 377
 378         @param eNewGrammar
 379             The new grammar to be set and the associated reference convention.
 380
 381         @param eOldGrammar
 382             The previous grammar that was active before SetFormulaLanguage().
 383      */
 384     void            SetGrammarAndRefConvention(
 385                         const formula::FormulaGrammar::Grammar eNewGrammar,
 386                         const formula::FormulaGrammar::Grammar eOldGrammar );
 387 public:
 388
 389     /// Set external link info for ScAddress::CONV_XL_OOX.
 390     inline  void    SetExternalLinks(
 391             const ::com::sun::star::uno::Sequence<
 392             const ::com::sun::star::sheet::ExternalLinkInfo > & rLinks )
 393     {
 394         maExternalLinks = rLinks;
 395     }
 396
 397     void            SetExtendedErrorDetection( bool bVal ) { mbExtendedErrorDetection = bVal; }
 398
 399     BOOL            IsCorrected() { return bCorrected; }
 400     const String&   GetCorrectedFormula() { return aCorrectedFormula; }
 401
 402     // Use convention from this->aPos by default
 403     ScTokenArray* CompileString( const String& rFormula );
 404     const ScDocument* GetDoc() const { return pDoc; }
 405     const ScAddress& GetPos() const { return aPos; }
 406
 407     void MoveRelWrap();
 408     static void MoveRelWrap( ScTokenArray& rArr, ScDocument* pDoc,
 409                              const ScAddress& rPos );
 410
 411     BOOL UpdateNameReference( UpdateRefMode eUpdateRefMode,
 412                               const ScRange&,
 413                               SCsCOL nDx, SCsROW nDy, SCsTAB nDz,
 414                               BOOL& rChanged, BOOL bSharedFormula = FALSE);
 415
 416     ScRangeData* UpdateReference( UpdateRefMode eUpdateRefMode,
 417                                   const ScAddress& rOldPos, const ScRange&,
 418                                   SCsCOL nDx, SCsROW nDy, SCsTAB nDz,
 419                                   BOOL& rChanged, BOOL& rRefSizeChanged );
 420
 421     /// Only once for converted shared formulas,
 422     /// token array has to be compiled afterwards.
 423     void UpdateSharedFormulaReference( UpdateRefMode eUpdateRefMode,
 424                                   const ScAddress& rOldPos, const ScRange&,
 425                                   SCsCOL nDx, SCsROW nDy, SCsTAB nDz );
 426
 427     ScRangeData* UpdateInsertTab(SCTAB nTable, BOOL bIsName );
 428     ScRangeData* UpdateDeleteTab(SCTAB nTable, BOOL bIsMove, BOOL bIsName, BOOL& bCompile);
 429     ScRangeData* UpdateMoveTab(SCTAB nOldPos, SCTAB nNewPos, BOOL bIsName );
 430
 431     BOOL HasModifiedRange();
 432
 433     /// If the character is allowed as first character in sheet names or references
 434     static inline BOOL IsCharWordChar( String const & rStr,
 435                                        xub_StrLen nPos,
 436                                        const formula::FormulaGrammar::AddressConvention eConv = formula::FormulaGrammar::CONV_OOO )
 437         {
 438             sal_Unicode c = rStr.GetChar( nPos );
 439             return c < 128 ?
 440                 static_cast<BOOL>(
 441                     (pConventions[eConv]->mpCharTable[ UINT8(c) ] & SC_COMPILER_C_CHAR_WORD) == SC_COMPILER_C_CHAR_WORD) :
 442                 ScGlobal::pCharClass->isLetterNumeric( rStr, nPos );
 443         }
 444
 445     /// If the character is allowed in sheet names or references
 446     static inline BOOL IsWordChar( String const & rStr,
 447                                    xub_StrLen nPos,
 448                                    const formula::FormulaGrammar::AddressConvention eConv = formula::FormulaGrammar::CONV_OOO )
 449         {
 450             sal_Unicode c = rStr.GetChar( nPos );
 451             return c < 128 ?
 452                 static_cast<BOOL>(
 453                     (pConventions[eConv]->mpCharTable[ UINT8(c) ] & SC_COMPILER_C_WORD) == SC_COMPILER_C_WORD) :
 454                 ScGlobal::pCharClass->isLetterNumeric( rStr, nPos );
 455         }
 456
 457 private:
 458     // FormulaCompiler
 459     virtual String FindAddInFunction( const String& rUpperName, BOOL bLocalFirst ) const;
 460     virtual void fillFromAddInCollectionUpperName( NonConstOpCodeMapPtr xMap ) const;
 461     virtual void fillFromAddInCollectionEnglishName( NonConstOpCodeMapPtr xMap ) const;
 462     virtual void fillFromAddInMap( NonConstOpCodeMapPtr xMap, formula::FormulaGrammar::Grammar _eGrammar ) const;
 463     virtual void fillAddInToken(::std::vector< ::com::sun::star::sheet::FormulaOpCodeMapEntry >& _rVec,bool _bIsEnglish) const;
 464
 465     virtual BOOL HandleExternalReference(const formula::FormulaToken& _aToken);
 466     virtual BOOL HandleRange();
 467     virtual BOOL HandleSingleRef();
 468     virtual BOOL HandleDbData();
 469
 470     virtual formula::FormulaTokenRef ExtendRangeReference( formula::FormulaToken & rTok1, formula::FormulaToken & rTok2, bool bReuseDoubleRef );
 471         virtual void CreateStringFromExternal(rtl::OUStringBuffer& rBuffer, formula::FormulaToken* pTokenP);
 472     virtual void CreateStringFromSingleRef(rtl::OUStringBuffer& rBuffer,formula::FormulaToken* _pTokenP);
 473     virtual void CreateStringFromDoubleRef(rtl::OUStringBuffer& rBuffer,formula::FormulaToken* _pTokenP);
 474     virtual void CreateStringFromMatrix( rtl::OUStringBuffer& rBuffer, formula::FormulaToken* _pTokenP);
 475     virtual void CreateStringFromIndex(rtl::OUStringBuffer& rBuffer,formula::FormulaToken* _pTokenP);
 476     virtual void LocalizeString( String& rName );       // modify rName - input: exact name
 477     virtual BOOL IsImportingXML() const;
 478
 479     /// Access the CharTable flags
 480     inline ULONG GetCharTableFlags( sal_Unicode c )
 481         { return c < 128 ? pConv->mpCharTable[ UINT8(c) ] : 0; }
 482 };
 483
 484 SC_DLLPUBLIC String GetScCompilerNativeSymbol( OpCode eOp ); //CHINA001
 485
 486 #endif