basic/source/inc/filefmt.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: filefmt.hxx,v $
  10  * $Revision: 1.7 $
  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 _SB_FILEFMT_HXX
  32 #define _SB_FILEFMT_HXX
  33
  34 #include <tools/solar.h>
  35
  36 class SvStream;
  37
  38 // Version  2: Datentyp des Returnwerts fuer Publics
  39 // Version  3: neue Opcodes
  40 // Version  4: neue Opcodes
  41 // Version  5: Bug (Ansprung von STATIC-Variablen im Init-Code)
  42 // Version  6: Neue Opcodes und Bug (Globals anlegen, ohne BASIC zu beenden)
  43 // Version  7: Korrektur im WITH-Parsing
  44 // Version  8: Korrektur im IF-Parsing
  45 // Version  9: Init-Code auch mit LEAVE beenden, wenn keine SUB/FUNCTION folgt
  46 // Version  A: #36374 Bei DIM AS NEW... auch Variablen anlegen
  47 // Version  B: #40689 Static umgestellt
  48 // Version  C: #41606 Bug bei Static
  49 // Version  D: #42678 Bug bei RTL-Function spc
  50 // Version  E: #56204 DCREATE, um auch bei DIM AS NEW Arrays anzulegen
  51 // Version  F: #57844 Einfuehrung von SvNumberformat::StringToDouble
  52 // Version 10: #29955 For-Schleifen-Level in Statement-PCodes generieren
  53 // Version 11: #29955 Wegen Build-Inkonsistenzen Neu-Compilieren erzwingen
  54
  55 #define B_LEGACYVERSION 0x00000011L
  56 #define B_CURVERSION 0x00000012L
  57 #define B_EXT_IMG_VERSION 0x00000012L
  58
  59 // Eine Datei enthaelt entweder einen Modul- oder einen Library-Record.
  60 // Diese Records enthalten wiederum weitere Records. Jeder Record hat
  61 // den folgenden Header:
  62
  63 //  UINT16 Kennung
  64 //  UINT32 Laenge des Records ohne Header
  65 //  UINT16 Anzahl Unterelemente
  66
  67 // Alle Datei-Offsets in Records sind relativ zum Start des Moduls!
  68
  69 #define B_LIBRARY               0x4C42          // BL Library Record
  70 #define B_MODULE                0x4D42          // BM Module Record
  71 #define B_NAME                  0x4E4D          // MN module name
  72 #define B_COMMENT               0x434D          // MC comment
  73 #define B_SOURCE                0x4353          // SC source code
  74 #define B_PCODE                 0x4350          // PC p-code
  75 #define B_OLDPUBLICS    0x7550          // Pu publics
  76 #define B_PUBLICS               0x5550          // PU publics
  77 #define B_POOLDIR               0x4450          // PD symbol pool directory
  78 #define B_SYMPOOL               0x5953          // SY symbol pool
  79 #define B_STRINGPOOL    0x5453          // ST symbol pool
  80 #define B_LINERANGES    0x524C          // LR line ranges for publics
  81 #define B_MODEND                0x454D          // ME module end
  82 #define B_SBXOBJECTS    0x5853          // SX SBX objects
  83
  84 #define EXTENDED_BINARY_MODULES
  85 #ifdef  EXTENDED_BINARY_MODULES
  86 #define B_EXTSOURCE             0x5345          // ES extended source
  87 #endif
  88
  89 // Ein Library Record enthaelt nur Module Records
  90 //  UINT16 Kennung BL
  91 //  UINT32 Laenge des Records
  92 //  UINT16 Anzahl Module
  93
  94 // Ein Modul-Record enthaelt alle anderen Recordtypen
  95 //  UINT16 Kennung BM
  96 //  UINT32 Laenge des Records
  97 //  UINT16 1
  98 // Daten:
  99 //  UINT32 Versionsnummer
 100 //  UINT32 Zeichensatz
 101 //  UINT32 Startadresse Initialisierungscode
 102 //  UINT32 Startadresse Sub Main
 103 //  UINT32 Reserviert
 104 //  UINT32 Reserviert
 105
 106 // Modulname, Kommentar und Quellcode:
 107 //  UINT16 Kennung MN, MC oder SC
 108 //  UINT32 Laenge des Records
 109 //  UINT16 1
 110 // Daten:
 111 //  String-Instanz
 112
 113 // P-Code:
 114 //  UINT16 Kennung PC
 115 //  UINT32 Laenge des Records
 116 //  UINT16 1
 117 // Daten:
 118 //  Der P-Code als Bytesack
 119
 120 // Alle Symbole und Strings werden in einem String-Pool gehalten.
 121 // Verweise auf diese Strings sind in Form eines Indexes in diesen Pool.
 122
 123 // Liste aller Publics:
 124 //  UINT16 Kennung PU oder Pu
 125 //  UINT32 Laenge des Records
 126 //  UINT16 Anzahl der Publics
 127 // Daten fuer jeden Public-Eintrag:
 128 //  UINT16 String-Index
 129 //  UINT32 Startadresse im P-Code-Image (UINT16 fuer alte Publics)
 130 //  UINT16 Datentyp des Returnwertes (ab Version 2)
 131
 132 // Verzeichnis der Symbol-Tabellen:
 133 //  UINT16 Kennung SP
 134 //  UINT32 Laenge des Records
 135 //  UINT16 Anzahl der Symboltabellen
 136 // Daten fuer jede Symboltabelle:
 137 //  UINT16 Stringindex des Namens
 138 //  UINT16 Anzahl Symbole
 139 //  UINT16 Scope-Kennung
 140
 141 // Symboltabelle:
 142 //  UINT16 Kennung SY
 143 //  UINT32 Laenge des Records
 144 //  UINT16 Anzahl der Symbole
 145 // Daten:
 146 //  UINT16 Stringindex des Namens
 147 //  UINT16 Anzahl Symbole
 148 // Daten fuer jedes Symbol:
 149 //  UINT16 Stringindex des Namens
 150 //  UINT16 Datentyp
 151 //  UINT16 Laenge bei STRING*n-Symbolen (0x8000: STATIC-Variable)
 152
 153 // Stringpool:
 154 //  UINT16 Kennung ST
 155 //  UINT32 Laenge des Records
 156 //  UINT16 Anzahl der Strings
 157 // Daten fuer jeden String:
 158 //  UINT32 Offset in den Block aller Strings
 159 // Danach folgt der Block aller Strings, die dort als ASCIIZ-Strings liegen.
 160
 161 // Line Ranges:
 162 //  UINT16 Kennung LR
 163 //  UINT32 Laenge des Records
 164 //  UINT16 Anzahl der Strings
 165 // Daten fuer jedes Public:
 166 //  UINT16 1. Zeile (Sub XXX)
 167 //  UINT16 2. Zeile (End Sub)
 168
 169 // SBX-Objekte:
 170 // UINT16 Anzahl Objekte
 171 // ....   Objektdaten
 172
 173 ////////////////////////////////////////////////////////////////////////////
 174
 175 // Service-Routinen (in IMAGE.CXX)
 176
 177 BOOL  SbGood( SvStream& r );
 178 ULONG SbOpenRecord( SvStream&, UINT16 nSignature, UINT16 nElem );
 179 void  SbCloseRecord( SvStream&, ULONG );
 180
 181 #endif