eqtb.h

浏览该文件的文档.

#pragma once
#ifndef INC_EQTB_H
//
#define INC_EQTB_H
#include "global.h"       // [const] UMAXOF, static_assert
#include "tex_constant.h" // [const] SAVE_SIZE, FONT_BASE, HASH_SIZE, MIN_QUARTER_WORD, MAX_QUARTER_WORD
// [enum] CatCode
 
 
#define ACTIVE_BASE     1
#define SINGLE_BASE     (ACTIVE_BASE + 256)
#define NULL_CS         (SINGLE_BASE + 256)
 
 
#define eq_level_field(x)   x.hh.UU.U2.b1
#define eq_type_field(x)    x.hh.UU.U2.b0
#define equiv_field(x)      x.hh.rh
 
#define eq_level(x) eq_level_field(eqtb[x])
#define eq_type(x)  eq_type_field(eqtb[x])
#define equiv(x)    equiv_field(eqtb[x])
typedef enum _EqLevel {
    LEVEL_ZERO = MIN_QUARTER_WORD,
    LEVEL_ONE,
} EqLevel;
 
 
#define HASH_BASE   (NULL_CS + 1)
 
typedef enum _FrozenControlSeq {
    FROZEN_CONTROL_SEQUENCE = (HASH_BASE + HASH_SIZE),
    FROZEN_PROTECTION = FROZEN_CONTROL_SEQUENCE,
 
    FROZEN_CR,           
    FROZEN_END_GROUP,    
    FROZEN_RIGHT,        
    FROZEN_FI,           
    FROZEN_END_TEMPLATE, 
 
    FROZEN_ENDV,        
    FROZEN_RELAX,       
    END_WRITE,          
    FROZEN_DONT_EXPAND, 
    FROZEN_NULL_FONT,   
} FrozenControlSeq;
 
#define FONT_ID_BASE                (FROZEN_NULL_FONT - FONT_BASE)
#define UNDEFINED_CONTROL_SEQUENCE  (FROZEN_NULL_FONT + 257)
 
 
#define GLUE_BASE       (UNDEFINED_CONTROL_SEQUENCE + 1)
#define SKIP_BASE       (GLUE_BASE + GLUE_PARS)
#define MU_SKIP_BASE    (SKIP_BASE + 256)
 
enum SkipRegisters {
    LINE_SKIP_CODE = 0,      
    BASELINE_SKIP_CODE,      
    PAR_SKIP_CODE,           
    ABOVE_DISPLAY_SKIP_CODE, 
    BELOW_DISPLAY_SKIP_CODE, 
 
    ABOVE_DISPLAY_SHORT_SKIP_CODE = 5,
    BELOW_DISPLAY_SHORT_SKIP_CODE,
    LEFT_SKIP_CODE,  
    RIGHT_SKIP_CODE, 
    TOP_SKIP_CODE,   
 
    SPLIT_TOP_SKIP_CODE = 10, 
    TAB_SKIP_CODE,            
    SPACE_SKIP_CODE,          
    XSPACE_SKIP_CODE,         
    PAR_FILL_SKIP_CODE,       
 
    THIN_MU_SKIP_CODE = 15, 
    MED_MU_SKIP_CODE,       
    THICK_MU_SKIP_CODE,     
    GLUE_PARS               
}; // [p83#224] enum SkipRegisters
 
#define skip(x)     equiv(SKIP_BASE + x)
#define muskip(x)   equiv(MU_SKIP_BASE + x)
#define glue_par(x) equiv(GLUE_BASE + x)
 
#define lineskip                glue_par(LINE_SKIP_CODE)
#define baselineskip            glue_par(BASELINE_SKIP_CODE)
#define parskip                 glue_par(PAR_SKIP_CODE)
#define abovedisplayskip        glue_par(ABOVE_DISPLAY_SKIP_CODE)
#define belowdisplayskip        glue_par(BELOW_DISPLAY_SKIP_CODE)
#define abovedisplayshortskip   glue_par(ABOVE_DISPLAY_SHORT_SKIP_CODE)
#define belowdisplayshortskip   glue_par(BELOW_DISPLAY_SHORT_SKIP_CODE)
#define leftskip                glue_par(LEFT_SKIP_CODE)
#define rightskip               glue_par(RIGHT_SKIP_CODE)
#define topskip                 glue_par(TOP_SKIP_CODE)
#define splittopskip            glue_par(SPLIT_TOP_SKIP_CODE)
#define tabskip                 glue_par(TAB_SKIP_CODE)
#define spaceskip               glue_par(SPACE_SKIP_CODE)
#define xspaceskip              glue_par(XSPACE_SKIP_CODE)
#define parfillskip             glue_par(PAR_FILL_SKIP_CODE)
#define thinmuskip              glue_par(THIN_MU_SKIP_CODE)
#define medmuskip               glue_par(MED_MU_SKIP_CODE)
#define thickmuskip             glue_par(THICK_MU_SKIP_CODE)
 
 
#define LOCAL_BASE      (MU_SKIP_BASE + 256)
 
// [p87#230]
typedef enum _TokenListLoc {
    PAR_SHAPE_LOC = LOCAL_BASE,
 
    OUTPUT_ROUTINE_LOC, 
    EVERY_PAR_LOC,      
    EVERY_MATH_LOC,     
    EVERY_DISPLAY_LOC,  
    EVERY_HBOX_LOC,     
 
    EVERY_VBOX_LOC, 
    EVERY_JOB_LOC,  
    EVERY_CR_LOC,   
    ERR_HELP_LOC,   
 
    TOKS_BASE,
} TokenListLoc;
 
#define BOX_BASE        (TOKS_BASE + 256)
#define CUR_FONT_LOC    (BOX_BASE + 256)
#define MATH_FONT_BASE  (CUR_FONT_LOC + 1)
#define CAT_CODE_BASE   (MATH_FONT_BASE + 48)
#define LC_CODE_BASE    (CAT_CODE_BASE + 256)
#define UC_CODE_BASE    (LC_CODE_BASE + 256)
#define SF_CODE_BASE    (UC_CODE_BASE + 256)
#define MATH_CODE_BASE  (SF_CODE_BASE + 256)
 
// [p87#230]
#define parshapeptr     equiv(PAR_SHAPE_LOC)
#define outputroutine   equiv(OUTPUT_ROUTINE_LOC)
#define everypar        equiv(EVERY_PAR_LOC)
#define everymath       equiv(EVERY_MATH_LOC)
#define everydisplay    equiv(EVERY_DISPLAY_LOC)
#define everyhbox       equiv(EVERY_HBOX_LOC)
#define everyvbox       equiv(EVERY_VBOX_LOC)
#define everyjob        equiv(EVERY_JOB_LOC)
#define everycr         equiv(EVERY_CR_LOC)
#define errhelp         equiv(ERR_HELP_LOC)
 
#define toks(x)         equiv(TOKS_BASE + x)
#define box(x)          equiv(BOX_BASE + x)
#define cur_font        equiv(CUR_FONT_LOC)
#define fam_fnt(x)      equiv(MATH_FONT_BASE + x)
#define cat_code(x)     equiv(CAT_CODE_BASE + x)
#define lc_code(x)      equiv(LC_CODE_BASE + x)
#define uc_code(x)      equiv(UC_CODE_BASE + x)
#define sf_code(x)      equiv(SF_CODE_BASE + x)
#define math_code(x)    equiv(MATH_CODE_BASE + x)
 
#define NULL_FONT       FONT_BASE
#define VAR_CODE        28672
 
 
#define INT_BASE        (MATH_CODE_BASE + 256)
#define COUNT_BASE      (INT_BASE + INT_PARS)
#define DEL_CODE_BASE   (COUNT_BASE + 256)
 
typedef enum _DelimiterCodesTable {
    pretolerancecode = 0, 
    tolerancecode,        
    linepenaltycode,      
    hyphenpenaltycode,    
    exhyphenpenaltycode,  
 
    clubpenaltycode,         
    widowpenaltycode,        
    displaywidowpenaltycode, 
    brokenpenaltycode,       
    binoppenaltycode,        
 
    relpenaltycode = 10,
    predisplaypenaltycode,
    postdisplaypenaltycode,
    interlinepenaltycode,     
    doublehyphendemeritscode, 
 
    finalhyphendemeritscode, 
    adjdemeritscode,         
    magcode,                 
    delimiterfactorcode,     
    loosenesscode,           
 
    timecode = 20,      
    daycode,            
    monthcode,          
    yearcode,           
    showboxbreadthcode, 
 
    showboxdepthcode,  
    hbadnesscode,      
    vbadnesscode,      
    pausingcode,       
    tracingonlinecode, 
 
    tracingmacroscode = 30, 
    tracingstatscode,       
    tracingparagraphscode,  
    tracingpagescode,       
    tracingoutputcode,      
 
    tracinglostcharscode, 
    tracingcommandscode,  
    tracingrestorescode,  
    uchyphcode,           
    outputpenaltycode,    
 
    maxdeadcyclescode = 40, 
    hangaftercode,          
    floatingpenaltycode,    
    globaldefscode,         
    curfamcode,             
 
    ESCAPE_CHARcode,       
    defaulthyphencharcode, 
    defaultskewcharcode,   
    endlinecharcode,       
    newlinecharcode,       
 
    languagecode = 50,     
    lefthyphenmincode,     
    righthyphenmincode,    
    holdinginsertscode,    
    errorcontextlinescode, 
 
    INT_PARS = 55, 
} DelimiterCodesTable; // [#236] enum DelimiterCodesTable
 
#define del_code(x)     eqtb[DEL_CODE_BASE + x].int_
#define count(x)        eqtb[COUNT_BASE + x].int_
#define int_par(x)      eqtb[INT_BASE + x].int_
 
#define pretolerance            int_par(pretolerancecode)
#define tolerance               int_par(tolerancecode)
 
#define linepenalty             int_par(linepenaltycode)
#define hyphenpenalty           int_par(hyphenpenaltycode)
#define exhyphenpenalty         int_par(exhyphenpenaltycode)
#define clubpenalty             int_par(clubpenaltycode)
#define widowpenalty            int_par(widowpenaltycode)
#define displaywidowpenalty     int_par(displaywidowpenaltycode)
#define brokenpenalty           int_par(brokenpenaltycode)
#define binoppenalty            int_par(binoppenaltycode)
#define relpenalty              int_par(relpenaltycode)
#define predisplaypenalty       int_par(predisplaypenaltycode)
#define postdisplaypenalty      int_par(postdisplaypenaltycode)
#define interlinepenalty        int_par(interlinepenaltycode)
 
#define doublehyphendemerits    int_par(doublehyphendemeritscode)
#define finalhyphendemerits     int_par(finalhyphendemeritscode)
#define adjdemerits             int_par(adjdemeritscode)
#define mag                     int_par(magcode)
#define delimiterfactor         int_par(delimiterfactorcode)
#define looseness               int_par(loosenesscode)
#define tex_time                int_par(timecode)
#define day                     int_par(daycode)
#define month                   int_par(monthcode)
#define year                    int_par(yearcode)
#define showboxbreadth          int_par(showboxbreadthcode)
#define showboxdepth            int_par(showboxdepthcode)
#define hbadness                int_par(hbadnesscode)
#define vbadness                int_par(vbadnesscode)
#define pausing                 int_par(pausingcode)
 
#define tracingonline           int_par(tracingonlinecode)
#define tracingmacros           int_par(tracingmacroscode)
#define tracingstats            int_par(tracingstatscode)
#define tracingparagraphs       int_par(tracingparagraphscode)
#define tracingpages            int_par(tracingpagescode)
#define tracingoutput           int_par(tracingoutputcode)
#define tracinglostchars        int_par(tracinglostcharscode)
#define tracingcommands         int_par(tracingcommandscode)
#define tracingrestores         int_par(tracingrestorescode)
 
#define uchyph                  int_par(uchyphcode)
#define outputpenalty           int_par(outputpenaltycode)
#define maxdeadcycles           int_par(maxdeadcyclescode)
#define hangafter               int_par(hangaftercode)
#define floatingpenalty         int_par(floatingpenaltycode)
#define globaldefs              int_par(globaldefscode)
#define curfam                  int_par(curfamcode)
#define ESCAPE_CHAR             int_par(ESCAPE_CHARcode)
#define defaulthyphenchar       int_par(defaulthyphencharcode)
#define defaultskewchar         int_par(defaultskewcharcode)
#define end_line_char           int_par(endlinecharcode)
#define newlinechar             int_par(newlinecharcode)
#define language                int_par(languagecode)
#define lefthyphenmin           int_par(lefthyphenmincode)
#define righthyphenmin          int_par(righthyphenmincode)
#define holdinginserts          int_par(holdinginsertscode)
#define errorcontextlines       int_par(errorcontextlinescode)
 
 
#define DIMEN_BASE      (DEL_CODE_BASE + 256)
#define SCALED_BASE     (DIMEN_BASE + dimenpars)
#define EQTB_SIZE       (SCALED_BASE + 255)
 
typedef enum _DimensionRegisters {
    parindentcode = 0, 
    mathsurroundcode,  
    lineskiplimitcode, 
    hsizecode,         
    vsizecode,         
 
    maxdepthcode,      
    splitmaxdepthcode, 
    boxmaxdepthcode,   
    hfuzzcode,         
    vfuzzcode,         
 
    delimitershortfallcode = 10,
    nulldelimiterspacecode, 
    scriptspacecode,        
    predisplaysizecode,     
    displaywidthcode,       
 
    displayindentcode, 
    overfullrulecode,  
    hangindentcode,    
    hoffsetcode,       
    voffsetcode,       
 
    emergencystretchcode = 20,
    dimenpars, 
} DimensionRegisters; // [p99#247] enum DimensionRegisters
 
#define dimen(x)                eqtb[SCALED_BASE + x].sc
#define dimen_par(x)            eqtb[DIMEN_BASE + x].sc
 
#define parindent               dimen_par(parindentcode)
#define mathsurround            dimen_par(mathsurroundcode)
#define lineskiplimit           dimen_par(lineskiplimitcode)
#define hsize                   dimen_par(hsizecode)
#define vsize                   dimen_par(vsizecode)
#define maxdepth                dimen_par(maxdepthcode)
#define splitmaxdepth           dimen_par(splitmaxdepthcode)
#define boxmaxdepth             dimen_par(boxmaxdepthcode)
#define hfuzz                   dimen_par(hfuzzcode)
#define vfuzz                   dimen_par(vfuzzcode)
#define delimitershortfall      dimen_par(delimitershortfallcode)
#define nulldelimiterspace      dimen_par(nulldelimiterspacecode)
#define scriptspace             dimen_par(scriptspacecode)
#define predisplaysize          dimen_par(predisplaysizecode)
#define displaywidth            dimen_par(displaywidthcode)
#define displayindent           dimen_par(displayindentcode)
#define overfullrule            dimen_par(overfullrulecode)
#define hangindent              dimen_par(hangindentcode)
#define hoffset                 dimen_par(hoffsetcode)
#define voffset                 dimen_par(voffsetcode)
#define emergencystretch        dimen_par(emergencystretchcode) // end group S220x255_P81x101
 
 
#define savetype(x)     save_stack[x].hh.UU.U2.b0
#define savelevel(x)    save_stack[x].hh.UU.U2.b1
#define saveindex(x)    save_stack[x].hh.rh
 
#define saved(x)        save_stack[save_ptr + x].int_
 
enum SaveType {
    restoreoldvalue, 
    restorezero,     
    inserttoken,     
    levelboundary,   
}; // [#268] SaveType
 
enum GroupCode {
    bottomlevel = 0,   
    simplegroup,       
    hboxgroup,         
    adjustedhboxgroup, 
    vboxgroup,         
 
    vtopgroup = 5, 
    aligngroup,    
    noaligngroup,  
    outputgroup,   
    mathgroup,     
 
    discgroup = 10,  
    insertgroup,     
    vcentergroup,    
    mathchoicegroup, 
    semisimplegroup, 
 
    mathshiftgroup = 15, 
    mathleftgroup = 16,  
    MAX_GROUP_CODE = 16,
}; // [#269] GroupCode // end group S268x288_P109x114
 
 
// eqtb
extern MemoryWord eqtb[EQTB_SIZE + 1];
extern QuarterWord xeqlevel[EQTB_SIZE - INT_BASE + 1];
 
// eqtv_save
extern MemoryWord save_stack[SAVE_SIZE + 1];
extern UInt16 save_ptr;
extern UInt16 max_save_stack;
extern QuarterWord cur_level;
extern GroupCode cur_group;
 
 
extern void eqtb_init();
extern void eqtb_init_once();
extern void print_skip_param(Integer n);
extern void begin_diagnostic(void);
extern void end_diagnostic(Boolean blankline);
extern void show_eqtb(HalfWord n);
 
// fonts only
extern Integer get_defaultskewchar(void);
extern Integer get_defaulthyphenchar(void);
 
extern void eqtb_save_init();
extern void new_save_level(GroupCode c);
extern void eq_define(HalfWord p, QuarterWord t, HalfWord e);
extern void eq_word_define(HalfWord p, long w);
extern void geq_define(HalfWord p, QuarterWord t, HalfWord e);
extern void geq_word_define(HalfWord p, long w);
extern void save_for_after(HalfWord t);
extern void unsave(void);
extern void prepare_mag(void);
 
extern Boolean use_independence_date;
 
#endif /* INC_EQTB_H */