home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1999 March / PCWK3A99.iso / Linux / DDD331 / DDD-3_1_.000 / DDD-3_1_ / ddd-3.1.1 / ddd / printBox.h < prev    next >
Encoding:
C/C++ Source or Header  |  1998-08-03  |  9.3 KB  |  319 lines
  1. // $Id: printBox.h,v 1.11 1998/08/03 12:59:26 zeller Exp $  -*- C++ -*-
  2. // definitions for xfig-output - protocol version 2.1
  3. // comments in /*...*/ taken from xfig-spec-2.1
  4.  
  5. // Copyright (C) 1995 Technische Universitaet Braunschweig, Germany.
  6. // Written by Christian Lindig <lindig@ips.cs.tu-bs.de>.
  7. // 
  8. // This file is part of DDD.
  9. // 
  10. // DDD is free software; you can redistribute it and/or
  11. // modify it under the terms of the GNU General Public
  12. // License as published by the Free Software Foundation; either
  13. // version 2 of the License, or (at your option) any later version.
  14. // 
  15. // DDD is distributed in the hope that it will be useful,
  16. // but WITHOUT ANY WARRANTY; without even the implied warranty of
  17. // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  18. // See the GNU General Public License for more details.
  19. // 
  20. // You should have received a copy of the GNU General Public
  21. // License along with DDD -- see the file COPYING.
  22. // If not, write to the Free Software Foundation, Inc.,
  23. // 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24. // 
  25. // DDD is the data display debugger.
  26. // For details, see the DDD World-Wide-Web page, 
  27. // `http://www.cs.tu-bs.de/softech/ddd/',
  28. // or send a mail to the DDD developers <ddd@ips.cs.tu-bs.de>.
  29.  
  30. #ifndef _DDD_printBox_h
  31. #define _DDD_printBox_h
  32.  
  33. /*
  34. (1) The very first line is a comment line containing the name and version:
  35.     #FIG 2.1
  36.  
  37.     The character # at the first column of a line indicates that the line
  38.     is a comment line which will be ignored.
  39.  
  40. (2) The first non-comment line consists of two numbers :
  41.  
  42.     int    fig_resolution        (pixels/inch)
  43.     int    coordinate_system    (1 : origin is at the lower left corner
  44.                      2 : Upper left)
  45.  
  46.     Fig_resolution is the resolution fig is using for the current file.
  47.     It must always be 80 for compatibility with this version of Fig.
  48.     Pixels are assumed to be square.
  49. */
  50.  
  51. // The header.
  52. #define FIGHEAD "#FIG 2.1\n" \
  53.                 "80 2\n"     \
  54.                 "#Creator: Box::print() by Christian Lindig\n"
  55.  
  56.  
  57. /*
  58. (3) The rest of the file contains various objects.  An object can be one
  59.     of six classes (or types).
  60.  
  61.       i)    Arc.
  62.      ii)    Ellipse which is a generalization of circle.
  63.     iii)    Polyline which includes polygon and box.
  64.      iv)    Spline which includes closed/open control/interpolated spline.
  65.       v)    Text.
  66.      vi)    Compound object which is composed of one or more objects.
  67.  
  68.     In the following elaboration on object formats, every value of fig
  69.     output are separated by blank characters or new line ('\n').  The
  70.     value of the not-used parameters will be -1.
  71.  
  72.     Some fields are described as "enumeration type" or "bit vector"; the 
  73.     values which these fields can take are defined in the header file object.h.
  74.     The pen, arrow_type, and arrow_style fields are described as unused.
  75.     These values may be defined in some future version of Fig.
  76.  
  77.     The color field is defined as follows:
  78.  
  79.     -1 = Default
  80.      0 = Black
  81.      1 = Blue
  82.      2 = Green
  83.      3 = Cyan
  84.      4 = Red
  85.      5 = Magenta
  86.      6 = Yellow
  87.      7 = White
  88.      values from 8 to 2^30-1 = reserved for future use
  89.  
  90.     The depth field is defined as follows:
  91.  
  92.      0 ... 999 where larger value means object is deeper than (under)
  93.            objects with smaller depth
  94.  
  95.     The area fill field is defined as follows:
  96.     
  97.      0 = not filled
  98.      1 = white
  99.     ...  values from 2 to 20 are shades of grey, from lighter to darker
  100.     21 = black
  101.  
  102.     The line_style field is defined as follows:
  103.  
  104.     -1 = Default
  105.      0 = Solid
  106.      1 = Dashed
  107.      2 = Dotted
  108.  
  109.     The style_val field is defined as the length, in pixels, of the
  110.     on/off dashes for dashed lines, and the distance between the dots, in
  111.     pixels, for dotted lines.
  112. */
  113.  
  114. /*
  115.     (3.4) POLYLINE
  116.  
  117.     First line :
  118.     type    name            (brief description)
  119.     ----    ----            -------------------
  120.     int    object_code        (always 2)
  121.     int    sub_type        (1 : polyline
  122.                      2 : box
  123.                      3 : polygon
  124.                      4 : arc-box)
  125.                      5 : imported-eps bounding-box)
  126.     int    line_style        (enumeration type)
  127.     int    thickness        (pixels)
  128.     int    color            (enumeration type)
  129.     int    depth            (no units)
  130.     int    pen            (not used)
  131.     int    area_fill        (enumeration type)
  132.     float    style_val        (pixels)
  133.     int    radius            (pixels)
  134.     int    forward_arrow        (0: off, 1: on)
  135.     int    backward_arrow        (0: off, 1: on)
  136.  
  137.     Forward arrow line (Optional; absent if forward_arrow is 0) :
  138.     type    name            (brief description)
  139.     ----    ----            -------------------
  140.     int    arrow_type        (not used)
  141.     int    arrow_style        (not used)
  142.     float    arrow_thickness        (pixels)
  143.     float     arrow_width        (pixels)
  144.     float    arrow_height        (pixels)
  145.  
  146.     Backward arrow line (Optional; absent if backward_arrow is 0) :
  147.     type    name            (brief description)
  148.     ----    ----            -------------------
  149.     int    arrow_type        (not used)
  150.     int    arrow_style        (not used)
  151.     float    arrow_thickness        (pixels)
  152.     float    arrow_width        (pixels)
  153.     float    arrow_height        (pixels)
  154.  
  155.     Points line :
  156.     type    name            (brief description)
  157.     ----    ----            -------------------
  158.     int    x1, y1            (pixels)
  159.     int    x2, y2            (pixels)
  160.       .
  161.       .
  162.     int    xn, yn            (this will be the same as the 1st
  163.                     point for polygon and box)
  164.     int    x, y            (always 9999, 9999; marks the end of
  165.                     point for polygon and box)
  166.  
  167.     EPS line :
  168.     type    name            (brief description)
  169.     ----    ----            -------------------
  170.     bool    flipped            orientation = normal (0) or flipped (1)
  171.     char    file[]            name of eps file to import
  172. */ 
  173.  
  174. // A black line (for boxes, depth = 0)
  175. #define EDGEHEAD1 "2 1 0 " // +thickness
  176. #define EDGEHEAD2 " -1 2 0 0 0.000 0 0 0\n\t"
  177.  
  178. #define ARROW "-1 -1 1 4 10"
  179.  
  180. // Same, but with arrows (for edges, depth = 2)
  181. #define ARROWHEAD1 "2 1 0 " // +thickness
  182. #define ARROWHEAD2 " -1 2 0 0 0.000 0 1 0\n\t" ARROW "\n\t"
  183.  
  184. // A black line (for boxes, depth = 0)
  185. #define LINEHEAD1 "2 1 0 " // +thickness
  186. #define LINEHEAD2 " -1 0 0 0 0.000 0 0 0\n\t"
  187.  
  188. // A black rule (for boxes, depth = 0)
  189. #define RULEHEAD "2 2 0 1 -1 0 0 21 0.000 0 0 0\n\t"
  190.  
  191. // A white rectangle in the background (behind boxes, depth = 1)
  192. #define CLEANHEAD "2 2 0 0 7 1 0 21 0.000 0 0 0\n\t"
  193.  
  194. /*
  195.     (3.1) ARC
  196.  
  197.     First line :
  198.     type    name            (brief description)
  199.     ----    ----            -------------------
  200.     int    object_code        (always 5)
  201.     int    sub_type        (always    1)
  202.     int    line_style        (enumeration type)
  203.     int    line_thickness        (pixels)
  204.     int    color            (enumeration type)
  205.     int    depth            (enumeration type)
  206.     int    pen            (not used)
  207.     int    area_fill        (enumeration type)
  208.     float    style_val        (pixels)
  209.     int    direction        (0 : clockwise, 1 : counterclockwise)
  210.     int    forward_arrow        (0: no forward arrow, 1: on)
  211.     int    backward_arrow        (0: no forward arrow, 1: on)
  212.     float    center_x, center_y    (center of the arc)
  213.     int    x1, y1            (pixels, the 1st point the user entered)
  214.     int    x2, y2            (pixels, the 2nd point)
  215.     int    x3, y3            (pixels, the last point)
  216.  
  217.     Forward arrow line (Optional; absent if forward_arrow is 0) :
  218.     type    name            (brief description)
  219.     ----    ----            -------------------
  220.     int    arrow_type        (not used)
  221.     int    arrow_style        (not used)
  222.     float    arrow_thickness        (pixels)
  223.     float     arrow_width        (pixels)
  224.     float    arrow_height        (pixels)
  225.  
  226.     Backward arrow line (Optional; absent if backward_arrow is 0) :
  227.     type    name            (brief description)
  228.     ----    ----            -------------------
  229.     int    arrow_type        (not used)
  230.     int    arrow_style        (not used)
  231.     float    arrow_thickness        (pixels)
  232.     float    arrow_width        (pixels)
  233.     float    arrow_height        (pixels)
  234.  
  235. */
  236.  
  237. // An arc line (for boxes, depth = 0)
  238. #define ARCCLOCKWISE        "0 "
  239. #define ARCCOUNTERCLOCKWISE "1 "
  240.  
  241. #define ARCHEAD1 "5 1 0 " // +thickness
  242. #define ARCHEAD2 " -1 0 0 0 0.000 " // + ARC[COUNTER]CLOCKWISE
  243. #define ARCHEAD3 "0 0 " // +center, P1, P2, P3
  244.  
  245. // Same, but with arrows (for edges, depth = 2)
  246. #define ARCARROWHEAD1 "5 1 0 " // +thickness
  247. #define ARCARROWHEAD2 " -1 2 0 0 0.000 " // + ARC[COUNTER]CLOCKWISE
  248. #define ARCARROWHEAD3 "1 0 " // +center, P1, P2, P3
  249. #define ARCARROWHEAD4 "\n\t" ARROW "\n"
  250.  
  251.  
  252. /*
  253.     (3.2) COMPOUND
  254.  
  255.     A line with object code 6 signifies the start of a compound.
  256.     There are four more numbers on this line which indicate the
  257.     upper right corner and the lower left corner of the bounding
  258.     box of this compound.  A line with object code -6 signifies
  259.     the end of the compound.  Compound may be nested.
  260.  
  261.     First line :
  262.     type    name            (brief description)
  263.     ----    ----            -------------------
  264.     int    object_code        (always 6)
  265.     int    upperright_corner_x    (pixels)
  266.     int    upperright_corner_y    (pixels)
  267.     int    lowerleft_corner_x    (pixels)
  268.     int    lowerleft_corner_y    (pixels)
  269.  
  270.     Subsequent lines :
  271.     objects
  272.     .
  273.     .
  274.  
  275.     Last line :
  276.     -6
  277. */
  278.  
  279. #define CMPHEAD "6 " // +corners
  280. #define CMPTAIL "-6\n"
  281.  
  282.  
  283. /*
  284.     (3.6) TEXT
  285.     type    name            (brief description)
  286.     ----    ----            -------------------
  287.     int    object             (always 4)
  288.     int    sub_type        (0 : Left justified
  289.                      1 : Center justified
  290.                      2 : Right justified)
  291.     int    font             (enumeration type)
  292.     int    font_size         (points)
  293.     int    pen            (not used)
  294.     int    color            (enumeration type)
  295.     int    depth            (no units)
  296.     float    angle            (radians, the angle of the text)
  297.     int    font_flags        (bit vector)
  298.     int    height            (pixels)
  299.     int    length            (pixels)
  300.     int    x, y            (pixels, coordinate of the origin
  301.                      of the string.  If sub_type = 0, it is
  302.                      the lower left corner of the string.
  303.                      If sub_type = 1, it is the lower
  304.                      center.  Otherwise it is the lower
  305.                      right corner of the string.)
  306.     char    string[]        (ascii characters; starts after a blank
  307.                     character following the last number and
  308.                     ends before the character '\1'.  This
  309.                     character is not part of the string.
  310.                     Note that the string may contain '\n'.)
  311. */
  312.  
  313. // Texts (depth = 0)
  314. #define TEXTHEAD1 "4 0 " // +font +font_size
  315. #define TEXTHEAD2 " 0 -1 0 0.000 4 "
  316.  
  317. #endif // _DDD_printBox_h
  318. // DON'T ADD ANYTHING BEHIND THIS #endif
  319.