idl/source/prj/database.cxx

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #include <sal/config.h>
  21
  22 #include <algorithm>
  23 #include <stdio.h>
  24 #include <stdlib.h>
  25 #include <database.hxx>
  26 #include <globals.hxx>
  27 #include <rtl/strbuf.hxx>
  28 #include <osl/file.hxx>
  29
  30
  31 SvParseException::SvParseException( SvTokenStream const & rInStm, const OString& rError )
  32 {
  33     SvToken& rTok = rInStm.GetToken();
  34     aError = SvIdlError( rTok.GetLine(), rTok.GetColumn() );
  35     aError.SetText( rError );
  36 };
  37
  38 SvParseException::SvParseException( const OString& rError, SvToken const & rTok )
  39 {
  40     aError = SvIdlError( rTok.GetLine(), rTok.GetColumn() );
  41     aError.SetText( rError );
  42 };
  43
  44
  45 SvIdlDataBase::SvIdlDataBase( const SvCommand& rCmd )
  46     : bExport( false )
  47     , nUniqueId( 0 )
  48     , nVerbosity( rCmd.nVerbosity )
  49 {
  50     sSlotMapFile = rCmd.aSlotMapFile;
  51 }
  52
  53 SvIdlDataBase::~SvIdlDataBase()
  54 {
  55     aIdFileList.clear();
  56 }
  57
  58 #define ADD_TYPE( Name )            \
  59     aTypeList.push_back( new SvMetaType( SvHash_##Name()->GetName() ) );
  60
  61 SvRefMemberList<SvMetaType *>& SvIdlDataBase::GetTypeList()
  62 {
  63     if( aTypeList.empty() )
  64     { // fill initially
  65         aTypeList.push_back( new SvMetaTypeString() );
  66         aTypeList.push_back( new SvMetaTypevoid() );
  67
  68         // MI: IDispatch::Invoke can not unsigned
  69         ADD_TYPE( UINT16 );
  70         ADD_TYPE( INT16 );
  71         ADD_TYPE( UINT32 );
  72         ADD_TYPE( INT32 );
  73         ADD_TYPE( BOOL );
  74         ADD_TYPE( BYTE );
  75         ADD_TYPE( float );
  76         ADD_TYPE( double );
  77         ADD_TYPE( SbxObject );
  78
  79         // Attention! When adding types all binary data bases get incompatible
  80
  81     }
  82     return aTypeList;
  83 }
  84
  85 void SvIdlDataBase::SetError( const OString& rError, SvToken const & rTok )
  86 {
  87     if( rTok.GetLine() > 10000 )
  88         aError.SetText( "line count overflow" );
  89
  90     if( aError.nLine < rTok.GetLine()
  91       || (aError.nLine == rTok.GetLine() && aError.nColumn < rTok.GetColumn()) )
  92     {
  93         aError = SvIdlError( rTok.GetLine(), rTok.GetColumn() );
  94         aError.SetText( rError );
  95     }
  96 }
  97
  98 void SvIdlDataBase::SetAndWriteError( SvTokenStream & rInStm, const OString& rError )
  99 {
 100     SetError( rError, rInStm.GetToken() );
 101     WriteError( rInStm );
 102 }
 103
 104 void SvIdlDataBase::Push( SvMetaObject * pObj )
 105 {
 106     GetStack().push_back( pObj );
 107 }
 108
 109 bool SvIdlDataBase::FindId( const OString& rIdName, sal_uLong * pVal )
 110 {
 111     if( pIdTable )
 112     {
 113         sal_uInt32 nHash;
 114         if( pIdTable->Test( rIdName, &nHash ) )
 115         {
 116             *pVal = pIdTable->Get( nHash )->GetValue();
 117             return true;
 118         }
 119     }
 120     return false;
 121 }
 122
 123 void SvIdlDataBase::InsertId( const OString& rIdName, sal_uLong nVal )
 124 {
 125     if( !pIdTable )
 126         pIdTable.reset( new SvStringHashTable );
 127
 128     sal_uInt32 nHash;
 129     pIdTable->Insert( rIdName, &nHash )->SetValue( nVal );
 130 }
 131
 132 bool SvIdlDataBase::ReadIdFile( const OString& rOFileName )
 133 {
 134     OUString rFileName = OStringToOUString(rOFileName, RTL_TEXTENCODING_ASCII_US);
 135     OUString aFullName;
 136     osl::File::searchFileURL( rFileName, GetPath(), aFullName);
 137     osl::FileBase::getSystemPathFromFileURL( aFullName, aFullName );
 138
 139     for ( size_t i = 0, n = aIdFileList.size(); i < n; ++i )
 140         if ( aIdFileList[ i ] == rFileName )
 141             return true;
 142
 143     aIdFileList.push_back( rFileName );
 144     AddDepFile( aFullName );
 145     SvTokenStream aTokStm( aFullName );
 146     if( aTokStm.GetStream().GetError() != ERRCODE_NONE )
 147         return false;
 148
 149     SvToken& rTok = aTokStm.GetToken_Next();
 150
 151     while( !rTok.IsEof() )
 152     {
 153         if( rTok.IsChar() && rTok.GetChar() == '#' )
 154         {
 155             rTok = aTokStm.GetToken_Next();
 156             if( rTok.Is( SvHash_define() ) )
 157             {
 158                 rTok = aTokStm.GetToken_Next();
 159                 OString aDefName;
 160                 if( !rTok.IsIdentifier() )
 161                     throw SvParseException( "unexpected token after define", rTok );
 162                 aDefName = rTok.GetString();
 163
 164                 sal_uLong nVal = 0;
 165                 bool bOk = true;
 166                 while( bOk )
 167                 {
 168                     rTok = aTokStm.GetToken_Next();
 169                     if (rTok.GetTokenAsString().startsWith("TypedWhichId"))
 170                     {
 171                         rTok = aTokStm.GetToken_Next();
 172                         if( !rTok.IsChar() || rTok.GetChar() != '<')
 173                             throw SvParseException( "expected '<'", rTok );
 174                         rTok = aTokStm.GetToken_Next();
 175                         if( !rTok.IsIdentifier() )
 176                             throw SvParseException( "expected identifier", rTok );
 177                         rTok = aTokStm.GetToken_Next();
 178                         if( !rTok.IsChar() || rTok.GetChar() != '>')
 179                             throw SvParseException( "expected '<'", rTok );
 180                         rTok = aTokStm.GetToken_Next();
 181                     }
 182                     else if( rTok.IsIdentifier() )
 183                     {
 184                         sal_uLong n;
 185                         if( FindId( rTok.GetString(), &n ) )
 186                             nVal += n;
 187                         else
 188                             bOk = false;
 189                     }
 190                     else if( rTok.IsChar() )
 191                     {
 192                         if( rTok.GetChar() == '-'
 193                           || rTok.GetChar() == '/'
 194                           || rTok.GetChar() == '*'
 195                           || rTok.GetChar() == '&'
 196                           || rTok.GetChar() == '|'
 197                           || rTok.GetChar() == '^'
 198                           || rTok.GetChar() == '~' )
 199                         {
 200                             throw SvParseException( "unknown operator '" + OStringChar(rTok.GetChar()) + "'in define", rTok );
 201                         }
 202                         if( rTok.GetChar() != '+'
 203                           && rTok.GetChar() != '('
 204                           && rTok.GetChar() != ')' )
 205                             // only + is allowed, parentheses are immaterial
 206                             // because + is commutative
 207                             break;
 208                     }
 209                     else if( rTok.IsInteger() )
 210                     {
 211                         nVal += rTok.GetNumber();
 212                     }
 213                     else
 214                         break;
 215                 }
 216                 if( bOk )
 217                 {
 218                     InsertId( aDefName, nVal );
 219                 }
 220             }
 221             else if( rTok.Is( SvHash_include() ) )
 222             {
 223                 rTok = aTokStm.GetToken_Next();
 224                 OStringBuffer aNameBuf(128);
 225                 if( rTok.IsString() )
 226                     aNameBuf.append(rTok.GetString());
 227                 else if( rTok.IsChar() && rTok.GetChar() == '<' )
 228                 {
 229                     rTok = aTokStm.GetToken_Next();
 230                     while( !rTok.IsEof()
 231                       && !(rTok.IsChar() && rTok.GetChar() == '>') )
 232                     {
 233                         aNameBuf.append(rTok.GetTokenAsString());
 234                         rTok = aTokStm.GetToken_Next();
 235                     }
 236                     if( rTok.IsEof() )
 237                     {
 238                         throw SvParseException("unexpected eof in #include", rTok);
 239                     }
 240                 }
 241                 OString aName(aNameBuf.makeStringAndClear());
 242                 if (aName == "sfx2/groupid.hxx")
 243                 {
 244                     // contains C++ code which we cannot parse
 245                     // we special-case this by defining a macro internally in...
 246                 }
 247                 else if (aName == "svl/typedwhich.hxx")
 248                 {
 249                     // contains C++ code which we cannot parse
 250                 }
 251                 else if (!ReadIdFile(aName))
 252                 {
 253                     throw SvParseException("cannot read file: " + aName, rTok);
 254                 }
 255             }
 256         }
 257         else
 258             rTok = aTokStm.GetToken_Next();
 259     }
 260     return true;
 261 }
 262
 263 SvMetaType * SvIdlDataBase::FindType( const SvMetaType * pPType,
 264                                     SvRefMemberList<SvMetaType *>& rList )
 265 {
 266     for (auto const& elem : rList)
 267         if( elem == pPType )
 268             return elem;
 269     return nullptr;
 270 }
 271
 272 SvMetaType * SvIdlDataBase::FindType( const OString& rName )
 273 {
 274     for (auto const& elem : aTypeList)
 275         if( rName == elem->GetName() )
 276             return elem;
 277     return nullptr;
 278 }
 279
 280 SvMetaType * SvIdlDataBase::ReadKnownType( SvTokenStream & rInStm )
 281 {
 282     sal_uInt32  nTokPos = rInStm.Tell();
 283     SvToken& rTok = rInStm.GetToken_Next();
 284
 285     if( rTok.IsIdentifier() )
 286     {
 287         const OString& aName = rTok.GetString();
 288         for( const auto& aType : GetTypeList() )
 289         {
 290             if( aType->GetName() == aName )
 291             {
 292                 return aType;
 293             }
 294         }
 295     }
 296     rInStm.Seek( nTokPos );
 297     return nullptr;
 298 }
 299
 300 SvMetaAttribute * SvIdlDataBase::ReadKnownAttr
 301 (
 302     SvTokenStream & rInStm,
 303     SvMetaType *    pType   /* If pType == NULL, then the type has
 304                                still to be read. */
 305 )
 306 {
 307     sal_uInt32  nTokPos = rInStm.Tell();
 308
 309     if( !pType )
 310         pType = ReadKnownType( rInStm );
 311
 312     if( !pType )
 313     {
 314         // otherwise SlotId?
 315         SvToken& rTok = rInStm.GetToken_Next();
 316         if( rTok.IsIdentifier() )
 317         {
 318             sal_uLong n;
 319             if( FindId( rTok.GetString(), &n ) )
 320             {
 321                 for( sal_uLong i = 0; i < aSlotList.size(); i++ )
 322                 {
 323                     SvMetaSlot * pSlot = aSlotList[i];
 324                     if( pSlot->GetSlotId().getString() == rTok.GetString() )
 325                         return pSlot;
 326                 }
 327             }
 328
 329             OStringBuffer aStr("Not found : ");
 330             aStr.append(rTok.GetString());
 331             OSL_FAIL(aStr.getStr());
 332         }
 333     }
 334
 335     rInStm.Seek( nTokPos );
 336     return nullptr;
 337 }
 338
 339 SvMetaAttribute* SvIdlDataBase::FindKnownAttr( const SvIdentifier& rId )
 340 {
 341     sal_uLong n;
 342     if( FindId( rId.getString(), &n ) )
 343     {
 344         for( sal_uLong i = 0; i < aSlotList.size(); i++ )
 345         {
 346             SvMetaSlot * pSlot = aSlotList[i];
 347             if( pSlot->GetSlotId().getString() == rId.getString() )
 348                 return pSlot;
 349         }
 350     }
 351
 352     return nullptr;
 353 }
 354
 355 SvMetaClass * SvIdlDataBase::ReadKnownClass( SvTokenStream & rInStm )
 356 {
 357     sal_uInt32  nTokPos = rInStm.Tell();
 358     SvToken& rTok = rInStm.GetToken_Next();
 359
 360     if( rTok.IsIdentifier() )
 361     {
 362         SvMetaClass* p = FindKnownClass(rTok.GetString());
 363         if (p)
 364             return p;
 365     }
 366
 367     rInStm.Seek( nTokPos );
 368     return nullptr;
 369 }
 370
 371 SvMetaClass * SvIdlDataBase::FindKnownClass( const OString& aName )
 372 {
 373     for( sal_uLong n = 0; n < aClassList.size(); n++ )
 374     {
 375         SvMetaClass * pClass = aClassList[n];
 376         if( pClass->GetName() == aName )
 377             return pClass;
 378     }
 379     return nullptr;
 380 }
 381
 382 void SvIdlDataBase::Write(const OString& rText) const
 383 {
 384     if( nVerbosity != 0 )
 385         fprintf( stdout, "%s", rText.getStr() );
 386 }
 387
 388 void SvIdlDataBase::WriteError( SvTokenStream & rInStm )
 389 {
 390     // error treatment
 391     OUString aFileName( rInStm.GetFileName() );
 392     OStringBuffer aErrorText;
 393     sal_uLong   nRow = 0, nColumn = 0;
 394
 395     rInStm.SeekToMax();
 396     SvToken& rTok = rInStm.GetToken();
 397
 398     // error position
 399     nRow    = rTok.GetLine();
 400     nColumn = rTok.GetColumn();
 401
 402     if( aError.IsError() )
 403     { // error set
 404         // search error token
 405         // error text
 406         if( !aError.GetText().isEmpty() )
 407         {
 408             aErrorText.append("may be <");
 409             aErrorText.append(aError.GetText());
 410         }
 411         SvToken * pPrevTok = nullptr;
 412         while( &rTok != pPrevTok )
 413         {
 414             pPrevTok = &rTok;
 415             if( rTok.GetLine() == aError.nLine
 416               && rTok.GetColumn() == aError.nColumn )
 417                 break;
 418             rTok = rInStm.GetToken_PrevAll();
 419         }
 420
 421         // error position
 422         aErrorText.append("> at ( ");
 423         aErrorText.append(static_cast<sal_Int64>(aError.nLine));
 424         aErrorText.append(", ");
 425         aErrorText.append(static_cast<sal_Int64>(aError.nColumn));
 426         aErrorText.append(" )");
 427
 428         // reset error
 429         aError = SvIdlError();
 430     }
 431
 432     // error treatment
 433     fprintf( stderr, "\n%s --- %s: ( %" SAL_PRIuUINTPTR ", %" SAL_PRIuUINTPTR " )\n",
 434              OUStringToOString(aFileName, RTL_TEXTENCODING_UTF8).getStr(),
 435              "error", nRow, nColumn );
 436
 437     if( !aErrorText.isEmpty() )
 438     { // error set
 439         fprintf( stderr, "\t%s\n", aErrorText.getStr() );
 440     }
 441
 442     // look for identifier close by
 443     if( !rTok.IsIdentifier() )
 444     {
 445         rInStm.GetToken_PrevAll();
 446         rTok = rInStm.GetToken();
 447     }
 448     if( rTok.IsIdentifier() )
 449     {
 450         OString aN = GetIdlApp().pHashTable->GetNearString( rTok.GetString() );
 451         if( !aN.isEmpty() )
 452             fprintf( stderr, "%s versus %s\n", rTok.GetString().getStr(), aN.getStr() );
 453     }
 454 }
 455
 456 SvIdlWorkingBase::SvIdlWorkingBase(const SvCommand& rCmd) : SvIdlDataBase(rCmd)
 457 {
 458 }
 459
 460
 461 bool SvIdlWorkingBase::WriteSfx( SvStream & rOutStm )
 462 {
 463     if( rOutStm.GetError() != ERRCODE_NONE )
 464         return false;
 465
 466     // reset all tmp variables for writing
 467     WriteReset();
 468     SvMemoryStream aTmpStm( 256000, 256000 );
 469     sal_uLong n;
 470     for( n = 0; n < GetModuleList().size(); n++ )
 471     {
 472         SvMetaModule * pModule = GetModuleList()[n];
 473         pModule->WriteSfx( *this, aTmpStm );
 474         aTmpStm.Seek( 0 );
 475     }
 476     for( n = 0; n < aUsedTypes.size(); n++ )
 477     {
 478         SvMetaType * pType = aUsedTypes[n];
 479         pType->WriteSfx( *this, rOutStm );
 480     }
 481     aUsedTypes.clear();
 482     rOutStm.WriteStream( aTmpStm );
 483     return true;
 484 }
 485
 486 void SvIdlDataBase::StartNewFile( const OUString& rName )
 487 {
 488     bExport = aExportFile.equalsIgnoreAsciiCase( rName );
 489     assert ( !bExport );
 490 }
 491
 492 void SvIdlDataBase::AppendSlot( SvMetaSlot *pSlot )
 493 {
 494     aSlotList.push_back( pSlot );
 495     assert ( !bExport );
 496 }
 497
 498 void SvIdlDataBase::AddDepFile(OUString const& rFileName)
 499 {
 500     m_DepFiles.insert(rFileName);
 501 }
 502
 503 struct WriteDep
 504 {
 505     SvFileStream & m_rStream;
 506     explicit WriteDep(SvFileStream & rStream) : m_rStream(rStream) { }
 507     void operator() (OUString const& rItem)
 508     {
 509         m_rStream.WriteCharPtr( " \\\n " );
 510         m_rStream.WriteOString( OUStringToOString(rItem, RTL_TEXTENCODING_UTF8) );
 511     }
 512 };
 513
 514 // write a dummy target for one included file, so the incremental build does
 515 // not break with "No rule to make target" if the included file is removed
 516 struct WriteDummy
 517 {
 518     SvFileStream & m_rStream;
 519     explicit WriteDummy(SvFileStream & rStream) : m_rStream(rStream) { }
 520     void operator() (OUString const& rItem)
 521     {
 522         m_rStream.WriteOString( OUStringToOString(rItem, RTL_TEXTENCODING_UTF8) );
 523         m_rStream.WriteCharPtr( " :\n\n" );
 524     }
 525 };
 526
 527 void SvIdlDataBase::WriteDepFile(
 528         SvFileStream & rStream, OUString const& rTarget)
 529 {
 530     rStream.WriteOString( OUStringToOString(rTarget, RTL_TEXTENCODING_UTF8) );
 531     rStream.WriteCharPtr( " :" );
 532     ::std::for_each(m_DepFiles.begin(), m_DepFiles.end(), WriteDep(rStream));
 533     rStream.WriteCharPtr( "\n\n" );
 534     ::std::for_each(m_DepFiles.begin(), m_DepFiles.end(), WriteDummy(rStream));
 535 }
 536
 537 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */