mirror of
https://github.com/keymanapp/keyman.git
synced 2026-09-13 11:07:42 +00:00
e5b31669af
The name compiler.h was misleading, so renamed to legacy_kmx_file.h, as it largely describes .kmx files. There are two declarations in the file which are specific to kmcmpdll, at the bottom of the file, but everything else is all related to the .kmx file format. (We may move those in a future update to kmcmpdll, but that should wait until the kmcmpdll cross-platform refactor is complete.) Moved to common/windows/cpp/include/ because it is used by both Developer and Windows projects. Where possible, removed redundant references, as compfile.h includes legacy_kmx_file.h anyway.
220 lines
6.7 KiB
C
220 lines
6.7 KiB
C
/*
|
|
Name: Compfile
|
|
Copyright: Copyright (C) SIL International.
|
|
Documentation:
|
|
Description:
|
|
Create Date: 25 Jan 2007
|
|
|
|
Modified Date: 25 May 2010
|
|
Authors: mcdurdin
|
|
Related Files:
|
|
Dependencies:
|
|
|
|
Bugs:
|
|
Todo:
|
|
Notes:
|
|
History: 25 Jan 2007 - mcdurdin - Add GLOBAL_BUFSIZE, enlarge LINESIZE
|
|
25 May 2010 - mcdurdin - I1632 - Keyboard Options
|
|
*/
|
|
|
|
#ifndef _COMPFILE_H
|
|
#define _COMPFILE_H
|
|
|
|
#include "../../../common/windows/cpp/include/legacy_kmx_file.h"
|
|
|
|
#define LINESIZE 8192
|
|
#define GLOBAL_BUFSIZE 4096
|
|
|
|
#define SZMAX_STORENAME 80
|
|
#define SZMAX_GROUPNAME 80
|
|
#define SZMAX_DEADKEYNAME 80
|
|
#define SZMAX_ERRORTEXT 512
|
|
#define SZMAX_VKDICTIONARYNAME 80
|
|
|
|
#define MAX_WARNINGS 100
|
|
|
|
#define T_COMMENT 1 // A comment line
|
|
#define T_KEYTOKEY 2 // A rule line
|
|
#define T_BLANK 3 // A blank line
|
|
|
|
#define T_W_START 4 // Start of easily matched line types
|
|
#define T_STORE 4 // A store line
|
|
#define T_VERSION 5 // A 'VERSION 3.2/3.1/3.0' line
|
|
#define T_NAME 6 // A 'NAME "xxxx"' line
|
|
#define T_BITMAP 7 // A 'BITMAP bmpfile' line
|
|
#define T_HOTKEY 8 // A 'HOTKEY "^%+C"' line
|
|
#define T_BEGIN 9 // A 'begin > use(xxxx)' line
|
|
#define T_GROUP 10 // A 'group(xxxx)' line
|
|
#define T_MATCH 11 // A 'match > "XXXX"' line
|
|
#define T_NOMATCH 12 // A 'nomatch > "XXXX"' line
|
|
#define T_SHIFT 13 // A 'SHIFT FREES CAPS' line
|
|
#define T_CAPSON 14 // A 'CAPS ON ONLY' line
|
|
#define T_CAPSOFF 15 // A 'CAPS ALWAYS OFF' line
|
|
#define T_LANGUAGE 16 // A 'LANGUAGE xxxh, xxh' line
|
|
#define T_LAYOUT 17 // A 'LAYOUT xxxxh' line
|
|
#define T_COPYRIGHT 18 // A 'COPYRIGHT "so and so"' line
|
|
#define T_MESSAGE 19 // A 'MESSAGE "so and so"' line
|
|
#define T_LANGUAGENAME 20 // A 'LANGUAGENAME "xxxx"' line
|
|
#define T_BITMAPS 21 // An unused 'BITMAPS' line (version 3.x)
|
|
#define T_W_END 21 // End of easily matched rule types
|
|
|
|
#define T_UNKNOWN 99 // Unrecognized line type (illegal line)
|
|
|
|
#define GDS_CUTLEAD 0x01 // GetDelimitedString: cut leading spaces
|
|
#define GDS_CUTFOLL 0x02 // GetDelimitedString: cut following spaces
|
|
|
|
#define GXS_LINE 0x00 // GetExtendedString error: in a "line"
|
|
#define GXS_RULE 0x01 // GetExtendedString error: in a "rule"
|
|
#define GXS_STORE 0x02 // GetExtendedString error: in a "store"
|
|
|
|
enum FileStoreType { FST_STORE, FST_OPTION, FST_RESERVED };
|
|
|
|
struct FILE_STORE {
|
|
DWORD dwSystemID;
|
|
WCHAR szName[SZMAX_STORENAME]; // the name of the store
|
|
PWSTR dpString; // from start of store structure
|
|
//FileStoreType fstType;
|
|
BOOL fIsStore;
|
|
BOOL fIsReserved;
|
|
BOOL fIsOption;
|
|
BOOL fIsDebug;
|
|
BOOL fIsCall;
|
|
int line; // TODO: int vs dword, line vs Line (see FILE_KEY, FILE_GROUP)
|
|
};
|
|
|
|
typedef FILE_STORE *PFILE_STORE;
|
|
|
|
struct FILE_KEY {
|
|
WCHAR Key; // WCHAR for consistency; only a byte used however
|
|
DWORD Line;
|
|
DWORD ShiftFlags;
|
|
PWSTR dpOutput; // from start of key structure
|
|
PWSTR dpContext; // from start of key structure
|
|
};
|
|
|
|
typedef FILE_KEY *PFILE_KEY;
|
|
|
|
struct FILE_GROUP {
|
|
WCHAR szName[SZMAX_GROUPNAME];
|
|
PFILE_KEY dpKeyArray; // address of first item in key array, from start of group structure
|
|
PWSTR dpMatch; // from start of group structure
|
|
PWSTR dpNoMatch; // from start of group structure
|
|
DWORD cxKeyArray; // in array items
|
|
BOOL fUsingKeys; // group(xx) [using keys] <-- specified or not
|
|
BOOL fReadOnly; // group(xx) [readonly] <-- specified or not
|
|
DWORD Line;
|
|
};
|
|
|
|
typedef FILE_GROUP *PFILE_GROUP;
|
|
|
|
struct FILE_DEADKEY
|
|
{
|
|
WCHAR szName[SZMAX_DEADKEYNAME];
|
|
};
|
|
|
|
typedef FILE_DEADKEY *PFILE_DEADKEY;
|
|
|
|
struct FILE_VKDICTIONARY
|
|
{
|
|
WCHAR szName[SZMAX_VKDICTIONARYNAME];
|
|
};
|
|
|
|
typedef FILE_VKDICTIONARY *PFILE_VKDICTIONARY;
|
|
|
|
struct FILE_KEYBOARD {
|
|
DWORD KeyboardID; // as stored in HKEY_LOCAL_MACHINE//system//currentcontrolset//control//keyboard layouts
|
|
|
|
DWORD version; // keyboard file version with VERSION keyword
|
|
|
|
PFILE_STORE dpStoreArray; // address of first item in store array, from start of store structure
|
|
PFILE_GROUP dpGroupArray; // address of first item in group array, from start of group structure
|
|
|
|
DWORD cxStoreArray; // in number of items
|
|
DWORD cxGroupArray; // in number of items
|
|
DWORD StartGroup[2]; // index of starting groups [ANSI=0, Unicode=1]
|
|
|
|
DWORD dwHotKey; // standard windows hotkey (hiword=shift/ctrl/alt stuff, loword=vkey)
|
|
|
|
WCHAR szName[SZMAX_KEYBOARDNAME]; // Keyboard layout name
|
|
WCHAR szLanguageName[SZMAX_LANGUAGENAME]; // Language name
|
|
WCHAR szCopyright[SZMAX_COPYRIGHT]; // Copyright information
|
|
WCHAR szMessage[SZMAX_MESSAGE]; // General information about the keyboard
|
|
PBYTE lpBitmap;
|
|
DWORD dwBitmapSize;
|
|
DWORD dwFlags; // Flags for the keyboard file
|
|
|
|
DWORD currentGroup; // temp - current processing group
|
|
DWORD currentStore; // temp - current processing store
|
|
DWORD cxDeadKeyArray;
|
|
PFILE_DEADKEY dpDeadKeyArray; // temp - dead key array
|
|
DWORD cxVKDictionary;
|
|
PFILE_VKDICTIONARY dpVKDictionary; // temp - virtual key dictionary
|
|
};
|
|
|
|
typedef FILE_KEYBOARD *PFILE_KEYBOARD;
|
|
|
|
/*
|
|
These size values are used in unit tests to ensure
|
|
that the structure sizes correspond precisely across
|
|
compilers (pas and c++).
|
|
*/
|
|
|
|
const DWORD sz_FILE_STORE = sizeof(FILE_STORE);
|
|
const DWORD sz_FILE_KEY = sizeof(FILE_KEY);
|
|
const DWORD sz_FILE_GROUP = sizeof(FILE_GROUP);
|
|
const DWORD sz_FILE_DEADKEY = sizeof(FILE_DEADKEY);
|
|
const DWORD sz_FILE_VKDICTIONARY = sizeof(FILE_VKDICTIONARY);
|
|
const DWORD sz_FILE_KEYBOARD = sizeof(FILE_KEYBOARD);
|
|
|
|
struct COMPMSG {
|
|
char szText[SZMAX_ERRORTEXT];
|
|
DWORD Line;
|
|
DWORD dwMsgCode;
|
|
};
|
|
|
|
typedef COMPMSG *PCOMPMSG;
|
|
|
|
struct COMPILEMESSAGES {
|
|
int nMessages;
|
|
int nErrors;
|
|
|
|
PCOMPMSG cm;
|
|
|
|
DWORD fatalCode;
|
|
char szFatalText[SZMAX_ERRORTEXT];
|
|
|
|
DWORD currentLine;
|
|
};
|
|
|
|
typedef COMPILEMESSAGES *PCOMPILEMESSAGES;
|
|
|
|
/*
|
|
struct TVersion
|
|
{
|
|
//int MinVersion; // 0x0500 usually
|
|
//int CompilerVersion[4];
|
|
//int MinCompilerVersion[4];
|
|
int KeyboardVersion; // 0x0500 usually
|
|
};
|
|
|
|
extern TVersion FVersionInfo;
|
|
*/
|
|
|
|
/*
|
|
#define bstrcpy(c,d) (LPBYTE)strcpy((LPSTR)(c),(LPSTR)(d))
|
|
#define bstrlen(c) strlen((LPSTR)(c))
|
|
#define bstrcmp(c,d) strcmp((LPSTR)(c),(LPSTR)(d))
|
|
#define bstrncmp(c,d,n) strncmp((LPSTR)(c),(LPSTR)(d),(n))
|
|
#define bstrnicmp(c,d,n) strnicmp((LPSTR)(c),(LPSTR)(d),(n))
|
|
#define bstricmp(c,d) stricmp((LPSTR)(c),(LPSTR)(d))
|
|
#define bstrchr(c,ch) (LPBYTE)strchr((LPSTR)(c),(char)ch)
|
|
#define bstrncpy(c,d,n) (LPBYTE)strncpy((LPSTR)(c),(LPSTR)(d),(n))
|
|
#define bstrtok(c,d) (LPBYTE)strtok((LPSTR)(c),(LPSTR)(d))
|
|
#define bstrcat(c,d) (LPBYTE)strcat((LPSTR)(c),(LPSTR)(d))
|
|
#define bstrncat(c,d,n) (LPBYTE)strncat((LPSTR)(c),(LPSTR)(d),(n))
|
|
#define bstrrev(c) (LPBYTE)strrev((LPSTR)(c))
|
|
#define batoi(c) atoi((LPSTR)(c))
|
|
#define bstrtol(c,d,n) strtol((LPSTR)(c),(LPSTR *)(d),(n))
|
|
*/
|
|
|
|
#endif // _COMPFILE_H
|