/* ScummVM - Graphic Adventure Engine
*
* ScummVM is the legal property of its developers, whose names
* are too numerous to list here. Please refer to the COPYRIGHT
* file distributed with this source distribution.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/
#ifndef GLK_ALAN2_ACODE
#define GLK_ALAN2_ACODE
#include "common/scummsys.h"
namespace Glk {
namespace Alan2 {
typedef size_t Aptr; // Type for an ACODE memory address
typedef uint32 Aword; // Type for an ACODE word
typedef uint32 Aaddr; // Type for an ACODE address
typedef uint32 Abool; // Type for an ACODE Boolean value
typedef int32 Aint; // Type for an ACODE Integer value
typedef int CodeValue; // Definition for the packing process
// Constants for the Acode file, words/block & bytes/block
#define BLOCKLEN 256L
#define BLOCKSIZE (BLOCKLEN*sizeof(Aword))
// Definitions for the packing process
#define VALUEBITS 16
#define EOFChar 256
#define TOPVALUE (((CodeValue)1<<VALUEBITS) - 1) // Highest value possible
// Half and quarter points in the code value range
#define ONEQUARTER (TOPVALUE / 4 + 1) // Point after first quarter
#define HALF (2 * ONEQUARTER) // Point after first half
#define THREEQUARTER (3 * ONEQUARTER) // Point after third quarter
// AMACHINE Word Classes
typedef int WrdKind;
#define WRD_SYN 0 // 1 - Synonym
#define WRD_ADJ 1 // 2 - Adjective
#define WRD_ALL 2 // 4 - All
#define WRD_BUT 3 // 8 - But
#define WRD_CONJ 4 // 16 - Conjunction
#define WRD_PREP 5 // 32 - Preposition
#define WRD_DIR 6 // 64 - Direction
#define WRD_IT 7 // 128 - It
#define WRD_NOISE 8 // 256 - Noise word
#define WRD_NOUN 9 // 512 - Noun
#define WRD_ACT 10 // 1024 - Actor
#define WRD_THEM 11 // 2048 - Them
#define WRD_VRB 12 // 4096 - Verb
#define WRD_CLASSES 13
// Syntax element classifications
#define EOS (-2) // End Of Syntax
// Syntax element flag bits
#define MULTIPLEBIT 0x1
#define OMNIBIT 0x2
// Parameter Classes
enum ClaKind { // NOTE! These must have the same order as
CLA_OBJ = 1 << 0, // the name classes in NAM.H
CLA_CNT = 1 << 1,
CLA_ACT = 1 << 2,
CLA_NUM = 1 << 3,
CLA_STR = 1 << 4,
CLA_COBJ = 1 << 5,
CLA_CACT = 1 << 6
};
// Verb Qualifiers
enum QualClass {
Q_DEFAULT,
Q_AFTER,
Q_BEFORE,
Q_ONLY
};
// The AMACHINE Operations
enum OpClass {
C_CONST,
C_STMOP,
C_CURVAR
};
enum InstClass {
I_PRINT, // Print a string from the text file
I_QUIT,
I_LOOK,
I_SAVE,
I_RESTORE,
I_LIST, // List contents of a container
I_EMPTY,
I_SCORE,
I_VISITS,
I_SCHEDULE,
I_CANCEL,
I_LOCATE,
I_MAKE,
I_SET, // Set a numeric attribute to the
// value on top of stack
I_STRSET, // Set a string valued attribute to a
// copy of the string on top of stack,
// deallocate current contents first
I_GETSTR, // Get a string contents from text
// file, create a copy and push it
// on top of stack
I_INCR, // Increment an attribute
I_DECR, // Decrement a numeric attribute
I_USE,
I_IN,
I_DESCRIBE,
I_SAY,
I_SAYINT,
I_SAYSTR,
I_IF,
I_ELSE,
I_ENDIF,
I_ATTRIBUTE,
I_STRATTR, // Push a copy of a string attribute
I_HERE,
I_NEAR,
I_WHERE,
I_AND,
I_OR,
I_NE,
I_EQ,
I_STREQ, // String compare
I_STREXACT,
I_LE,
I_GE,
I_LT,
I_GT,
I_PLUS,
I_MINUS,
I_MULT,
I_DIV,
I_NOT,
I_UMINUS,
I_RND,
I_SUM, // SUM-aggregate
I_MAX, // MAX-aggregate
I_COUNT, // COUNT-aggregate
I_RETURN,
I_SYSTEM,
I_RESTART, // INTRODUCED: v2.7
I_BTW, // INTRODUCED: v2.8
I_CONTAINS, // -""-
I_DEPSTART, // -""-
I_DEPCASE, // -""-
I_DEPEXEC, // -""-
I_DEPELSE, // -""-
I_DEPEND // -""-
};
enum VarClass {
V_PARAM,
V_CURLOC,
V_CURACT,
V_CURVRB,
V_SCORE
};
#define I_CLASS(x) ((x)>>28)
#define I_OP(x) ((x&0x8000000)?(x)|0x0f0000000:(x)&0x0fffffff)
struct AcdHdr {
// Important info
char vers[4]; // 01 - Version of compiler
Aword size; // 02 - Size of ACD-file in Awords
// Options
Abool pack; // 03 - Is the text packed ?
Aword paglen; // 04 - Length of a page
Aword pagwidth; // 05 - and width
Aword debug; // 06 - Option debug
// Data structures
Aaddr dict; // 07 - Dictionary
Aaddr oatrs; // 08 - Object default attributes
Aaddr latrs; // 09 - Location default attributes
Aaddr aatrs; // 0a - Actor default attributes
Aaddr acts; // 0b - Actor table
Aaddr objs; // 0c - Object table
Aaddr locs; // 0d - Location table
Aaddr stxs; // 0e - Syntax table
Aaddr vrbs; // 0f - Verb table
Aaddr evts; // 10 - Event table
Aaddr cnts; // 11 - Container table
Aaddr ruls; // 12 - Rule table
Aaddr init; // 13 - String init table
Aaddr start; // 14 - Start code
Aword msgs; // 15 - Messages table
// Miscellaneous
Aword objmin, objmax; // 16 - Interval for object codes
Aword actmin, actmax; // 18 - Interval for actor codes
Aword cntmin, cntmax; // 1a - Interval for container codes
Aword locmin, locmax; // 1c - Interval for location codes
Aword dirmin, dirmax; // 1e - Interval for direction codes
Aword evtmin, evtmax; // 20 - Interval for event codes
Aword rulmin, rulmax; // 22 - Interval for rule codes
Aword maxscore; // 24 - Maximum score
Aaddr scores; // 25 - Score table
Aaddr freq; // 26 - Address to Char freq's for coding
Aword acdcrc; // 27 - Checksum for acd code (excl. hdr)
Aword txtcrc; // 28 - Checksum for text data file
};
// Error message numbers
enum MsgKind {
M_HUH, // Obsolete
M_WHAT,
M_WHAT_ALL,
M_WHAT_IT,
M_WHAT_THEM,
M_MULTIPLE,
M_WANT,
M_NOUN,
M_AFTER_BUT,
M_BUT_ALL,
M_NOT_MUCH,
M_WHICH_ONE,
M_NO_SUCH,
M_NO_WAY,
M_CANT0,
M_CANT,
M_NOTHING, // Obsolete
M_SEEOBJ1,
M_SEEOBJ2,
M_SEEOBJ3,
M_SEEOBJ4,
M_SEEACT,
M_CONTAINS1,
M_CONTAINS2,
M_CONTAINS3,
M_CONTAINS4,
M_CONTAINS5,
M_EMPTY1,
M_EMPTY2,
M_SCORE1,
M_SCORE2,
M_UNKNOWN_WORD,
M_MORE,
M_AGAIN,
M_SAVEWHERE,
M_SAVEOVERWRITE,
M_SAVEFAILED,
M_SAVEMISSING,
M_SAVEVERS,
M_SAVENAME,
M_RESTOREFROM,
M_REALLY, // CHANGED: v2.7 from M_RESTART
M_QUITACTION, // INTRODUCED: v2.7, so M_ARTICLE moved
M_ARTICLE, // INTRODUCED: v2.6 but replaced the M_NOMSG
MSGMAX
};
#define M_ARTICLE26 M_QUITACTION
#define M_MSGMAX26 M_ARTICLE
} // End of namespace Alan2
} // End of namespace Glk
#endif