home *** CD-ROM | disk | FTP | other *** search
/ Dream 52 / Amiga_Dream_52.iso / Linux / Divers / lyx-0.13.2.tar.gz / lyx-0.13.2.tar / lyx-0.13.2 / src / layout.h < prev    next >
C/C++ Source or Header  |  1998-04-23  |  9KB  |  458 lines
  1. // -*- C++ -*-
  2. /* This file is part of
  3.  * ======================================================
  4. * 
  5. *           LyX, The Document Processor
  6. *      
  7. *        Copyright (C) 1995 Matthias Ettrich
  8. *
  9. *======================================================*/
  10.  
  11. #ifndef _LAYOUT_H
  12. #define _LAYOUT_H
  13.  
  14. #ifdef __GNUG__
  15. #pragma interface
  16. #endif
  17.  
  18. #include "definitions.h"
  19. #include "lyxlex.h"
  20. #include "lyxfont.h"
  21. #include "Spacing.h"
  22.  
  23. /// Reads the style files
  24. void LyXSetStyle();
  25.  
  26. /// The different margin types
  27. enum LYX_MARGIN_TYPE {
  28.     ///
  29.     MARGIN_MANUAL,
  30.     ///
  31.     MARGIN_FIRST_DYNAMIC,
  32.     ///
  33.     MARGIN_DYNAMIC,
  34.     ///
  35.     MARGIN_STATIC,
  36.     ///
  37.     MARGIN_RIGHT_ADDRESS_BOX
  38. };
  39.  
  40. ///
  41. enum LYX_ALIGNMENT {
  42.     ///
  43.     LYX_ALIGN_BLOCK = 1,
  44.     ///
  45.     LYX_ALIGN_LEFT = 2,
  46.     ///
  47.     LYX_ALIGN_RIGHT = 4,
  48.     ///
  49.     LYX_ALIGN_CENTER = 8,
  50.     ///
  51.     LYX_ALIGN_LAYOUT = 16,
  52.     ///
  53.         LYX_ALIGN_WIDTH = 32
  54. };
  55.  
  56. /// The different LaTeX-Types
  57. enum LYX_LATEX_TYPES {
  58.     ///
  59.     LATEX_PARAGRAPH,
  60.     ///
  61.     LATEX_COMMAND,
  62.     ///
  63.     LATEX_ENVIRONMENT,
  64.     ///
  65.     LATEX_ITEM_ENVIRONMENT,
  66.     ///
  67.     LATEX_LIST_ENVIRONMENT
  68. };
  69.  
  70. /// The different label types
  71. enum LYX_LABEL_TYPES {
  72.     ///
  73.     LABEL_NO_LABEL,
  74.     ///
  75.     LABEL_MANUAL,
  76.     ///
  77.         LABEL_BIBLIO,
  78.     ///
  79.     LABEL_TOP_ENVIRONMENT,
  80.     ///
  81.     LABEL_CENTERED_TOP_ENVIRONMENT,
  82.  
  83.     // the flushright labels following now must start with LABEL_STATIC
  84.     ///
  85.     LABEL_STATIC,
  86.     ///
  87.     LABEL_SENSITIVE,
  88.     ///
  89.     LABEL_COUNTER_CHAPTER,
  90.     ///
  91.     LABEL_COUNTER_SECTION,
  92.     ///
  93.     LABEL_COUNTER_SUBSECTION,
  94.     ///
  95.     LABEL_COUNTER_SUBSUBSECTION,
  96.     ///
  97.     LABEL_COUNTER_PARAGRAPH,
  98.     ///
  99.     LABEL_COUNTER_SUBPARAGRAPH,
  100.     ///
  101.     LABEL_COUNTER_ENUMI,
  102.     ///
  103.     LABEL_COUNTER_ENUMII,
  104.     ///
  105.     LABEL_COUNTER_ENUMIII,
  106.     ///
  107.     LABEL_COUNTER_ENUMIV,
  108.     ///
  109.     LABEL_FIRST_COUNTER = LABEL_COUNTER_CHAPTER
  110. };
  111.  
  112.  
  113. /* Fix labels are printed flushright, manual labels flushleft. 
  114. * MARGIN_MANUAL and MARGIN_FIRST_DYNAMIC are *only* for LABEL_MANUAL,
  115. * MARGIN_DYNAMIC and MARGIN_STATIC are *not* for LABEL_MANUAL. 
  116. * This seems a funny restriction, but I think other combinations are
  117. * not needed, so I will not change it yet. 
  118. * Correction: MARGIN_FIRST_DYNAMIC also usable with LABEL_STATIC */
  119.  
  120.  
  121. /* There is a parindent and a parskip. Which one is used depends on the 
  122. * paragraph_separation-flag of the text-object. 
  123. * BUT: parindent is only thrown away, if a parskip is defined! So if you
  124. * want a space between the paragraphs and a parindent at the same time, 
  125. * you should set parskip to zero and use topsep, parsep and bottomsep.
  126. * 
  127. * The standard layout is an exception: its parindent is only set, if the 
  128. * previous paragraph is standard too. Well, this is LateX and it is good! */ 
  129.  
  130.  
  131. /// Attributes of a layout/paragraph environment
  132. class LyXLayoutList;
  133. ///
  134. class LyXLayout {
  135. public:
  136.     ///
  137.     LyXLayout ();
  138.  
  139.     ///
  140.     ~LyXLayout ();
  141.  
  142.     ///
  143.     void Copy (LyXLayout const &l);
  144.  
  145.     ///
  146.     bool Read (LyXLex&, LyXLayoutList *);
  147.  
  148.     /// Name of the layout/paragraph environment
  149.     LString name;
  150.  
  151.     /// Name of an layout that has replaced this layout. 
  152.     /** This is used to rename a layout, while keeping backward
  153.         compatibility 
  154.     */
  155.     LString obsoleted_by;
  156.  
  157.     /// Default font for this layout/environment
  158.     /** The main font for this kind of environment. If an attribute has
  159.     LyXFont::INHERITED_*, it means that the value is specified by
  160.     the defaultfont for the entire layout. If we are nested, the font 
  161.     is inherited from the font in the environment one level up until the 
  162.     font is resolved. The values LyXFont::IGNORE_* and LyXFont::TOGGLE 
  163.     are illegal here.
  164.     */
  165.     LyXFont font;
  166.  
  167.     /// Default font for labels
  168.     /** Interpretation the same as for font above */
  169.     LyXFont labelfont;
  170.  
  171.     /// Resolved version of the font for this layout/environment
  172.     /** This is a resolved version the default font. The font is resolved
  173.     against the defaultfont of the entire layout. */
  174.     LyXFont resfont;
  175.  
  176.     /// Resolved version of the font used for labels
  177.     /** This is a resolved version the label font. The font is resolved
  178.     against the defaultfont of the entire layout. */
  179.     LyXFont reslabelfont;
  180.  
  181.     /// Text that dictates how wide the left margin is on the screen
  182.     LString leftmargin;
  183.  
  184.     /// Text that dictates how wide the right margin is on the screen
  185.     LString rightmargin;
  186.  
  187.     /// Text that dictates how much space to leave after a potential label
  188.     LString labelsep;
  189.  
  190.     /// Text that dictates how much space to leave before a potential label
  191.     LString labelindent;
  192.  
  193.     /// Text that dictates the width of the indentation of indented paragraphs
  194.     LString parindent;
  195.  
  196.     /// Label string. "Abstract", "Reference", "Caption"...
  197.     LString labelstring;
  198.  
  199.     /// LaTeX name for environment
  200.     LString latexname;
  201.  
  202.     /// LaTeX parameter for environment
  203.         LString latexparam;   //arrae970411
  204.  
  205.         /// Macro definitions needed for this layout
  206.     LString preamble;
  207.  
  208.     ///
  209.     float parskip;
  210.  
  211.     ///
  212.     float itemsep;
  213.  
  214.     ///
  215.     float topsep;
  216.  
  217.     ///
  218.     float bottomsep;
  219.  
  220.     ///
  221.     float labelbottomsep;
  222.  
  223.     ///
  224.     float parsep;
  225.  
  226.     ///
  227.     Spacing spacing;
  228.  
  229.     ///
  230.     char align; // add approp. signedness
  231.  
  232.     ///
  233.     char alignpossible; // add approp. signedness
  234.  
  235.     ///
  236.     char labeltype; // add approp. signedness
  237.  
  238.     ///
  239.     char margintype; // add approp. signedness
  240.  
  241.     ///
  242.     bool fill_top;
  243.  
  244.     ///
  245.     bool fill_bottom;
  246.  
  247.     ///
  248.     bool newline_allowed;
  249.  
  250.     ///
  251.     bool nextnoindent;
  252.  
  253.     ///
  254.     bool free_spacing;
  255.     /// true when the fragile commands in the paragraph need to be
  256.     /// \protect'ed.
  257.     bool needprotect;
  258.     /// true when empty paragraphs should be kept.
  259.     bool keepempty;
  260.     ///
  261.     bool isParagraph() const {
  262.         return latextype == LATEX_PARAGRAPH;
  263.     }
  264.     ///
  265.     bool isCommand() const { 
  266.         return latextype == LATEX_COMMAND;
  267.     }
  268.     ///
  269.     bool isEnvironment() const {
  270.         return (latextype == LATEX_ENVIRONMENT
  271.             || latextype == LATEX_ITEM_ENVIRONMENT
  272.             || latextype == LATEX_LIST_ENVIRONMENT);
  273.     }
  274.     /// Type of LaTeX object
  275.     LYX_LATEX_TYPES latextype;
  276.     /// Does this object belong in the title part of the document?
  277.     bool intitle;
  278. };
  279.  
  280.  
  281. ///
  282. class LyXLayoutList {
  283. public:
  284.     ///
  285.     LyXLayoutList();
  286.     ///
  287.     ~LyXLayoutList();
  288.     ///
  289.     void Add (LyXLayout *l);
  290.     ///
  291.     bool Delete (LString const &name);
  292.         ///
  293.     LyXLayout *GetLayout (LString const &name);
  294.     ///
  295.     LyXLayout *ToAr();
  296.     ///
  297.     int GetNum();
  298.     ///
  299.     void Clean(); 
  300. private:
  301.     ///
  302.     struct LyXLayoutL {
  303.         ///
  304.         LyXLayout* layout;
  305.         ///
  306.         LyXLayoutL *next;
  307.     };
  308.     ///
  309.     LyXLayoutL * l;
  310.     ///
  311.     LyXLayoutL *eol;
  312.     ///
  313.     int num_layouts;
  314. };
  315.  
  316.  
  317. ///
  318. class LyXTextClass  {
  319. public:
  320.     ///
  321.     LyXTextClass (LString const & = LString(), 
  322.               LString const & = LString(), 
  323.               LString const & = LString());
  324.     ///
  325.     ~LyXTextClass();
  326.  
  327.     /// Not a real copy, just reference!
  328.     void Copy (LyXTextClass const &l);
  329.  
  330.     /// Reads a textclass structure from file
  331.     int Read (LString const & filename, LyXLayoutList *list = NULL);
  332.  
  333.     /// Sees to that the textclass structure has been loaded
  334.     void load();
  335.  
  336.     ///
  337.     LString name;
  338.     ///
  339.     LString latexname;
  340.     ///
  341.     LString description;
  342.  
  343.     /// Specific class options
  344.         LString opt_fontsize;
  345.     ///
  346.         LString opt_pagestyle;
  347.     ///
  348.     LString options;
  349.     
  350.     /// Base font. This one has to be fully instantiated.
  351.     /** Base font. The paragraph and layout fonts are resolved against
  352.     this font. Attributes LyXFont::INHERIT, LyXFont::IGNORE, and 
  353.     LyXFont::TOGGLE are extremely illegal.
  354.     */
  355.     LyXFont defaultfont;
  356.     /// Array of styles in this textclass
  357.     LyXLayout* style;
  358.     ///
  359.     unsigned char number_of_defined_layouts;
  360.     ///
  361.     unsigned char columns;
  362.     ///
  363.     unsigned char sides;
  364.     ///
  365.     signed char secnumdepth;
  366.     ///
  367.     signed char tocdepth;
  368.     ///
  369.     LString pagestyle;
  370.     ///
  371.     LString preamble;
  372.     ///
  373.     /// Text that dictates how wide the left margin is on the screen
  374.     LString leftmargin;
  375.         ///
  376.     /// Text that dictates how wide the right margin is on the screen
  377.     LString rightmargin;
  378.         ///
  379.     char maxcounter; // add approp. signedness
  380. private:
  381.     /// Has this layout file been loaded yet?
  382.     bool loaded;
  383. };
  384.  
  385.  
  386. ///
  387. class LyXTextClassList {
  388. public:
  389.     ///
  390.     LyXTextClassList();
  391.  
  392.     ///
  393.     ~LyXTextClassList();
  394.  
  395.     /// Gets layout structure from layout number and textclass number
  396.     LyXLayout *Style(char textclass, char layout);
  397.  
  398.     /// Gets layout number from textclass number and layout name
  399.     char NumberOfLayout(char textclass, LString const & name); // add approp. signedness
  400.  
  401.     /// Gets a layout name from layout number and textclass number
  402.     LString NameOfLayout(char textclass, char layout); // add approp. signedness
  403.  
  404.     /// Gets textclass number from name
  405.     /** Returns -1 if textclass name does not exist */
  406.     signed char NumberOfClass(LString const & textclass);
  407.  
  408.     ///
  409.     LString NameOfClass(char number); // add approp. signedness
  410.  
  411.     ///
  412.     LString LatexnameOfClass(char number); // add approp. signedness
  413.  
  414.     ///
  415.     LString DescOfClass(char number); // add approp. signedness
  416.  
  417.     ///
  418.     LyXTextClass * TextClass(char textclass); // add approp. signedness
  419.  
  420.     /// Read textclass list
  421.     /** Returns false if this fails */
  422.     bool Read();
  423.  
  424.     /// Load textclass
  425.     /** Returns false if this fails */
  426.     bool Load(char textclass);
  427. private:
  428.     ///
  429.     struct LyXTextClassL {
  430.         ///
  431.         LyXTextClass * textclass;
  432.         ///
  433.         LyXTextClassL * next;
  434.     };
  435.  
  436.     ///
  437.     LyXTextClassL * l;
  438.  
  439.     ///
  440.     int num_textclass;
  441.  
  442.     /// After reading, this arrays holds the textclasses
  443.     LyXTextClass * ar;
  444.  
  445.     /// Add a textclass to list
  446.     void Add (LyXTextClass *l);
  447.  
  448.     /// Convert final linked list to array
  449.     /** We read the textclasses into a linked list. After the reading,
  450.     the list is converted to an array, and the linked list is nuked. */
  451.     void ToAr();
  452. };
  453.  
  454. /// Should not be declared here!! (Lgb) Why not? (Asger)
  455. extern LyXTextClassList lyxstyle;
  456.  
  457. #endif
  458.