summaryrefslogtreecommitdiff
path: root/src/fltk-draw.ads
blob: b4e14ee7b06b8d04c02395bbcd5d00b74a34d87a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617


with

    FLTK.Images,
    FLTK.Widgets.Groups.Windows;


package FLTK.Draw is


    --------------------------
    --  Types and Constants --
    --------------------------

    type Line_Kind is
       (Solid_Line,
        Dash_Line,
        Dot_Line,
        Dashdot_Line,
        Dashdotdot_Line);

    type Cap_Kind is
       (Default_Cap,
        Flat_Cap,
        Round_Cap,
        Square_Cap);

    type Join_Kind is
       (Default_Join,
        Miter_Join,
        Round_Join,
        Bevel_Join);

    type Dash_Length is new Integer range 1 .. 255;

    type Dash_Gap is record
        Solid : Dash_Length;
        Blank : Dash_Length;
    end record;

    type Dash_Gap_Array is array (Positive range <>) of Dash_Gap;

    Empty_Dashes : constant Dash_Gap_Array (1 .. 0) := (others => (1, 1));

    type Image_Draw_Function is access procedure
           (X, Y : in     Natural;
            Data :    out Color_Component_Array);

    type Symbol_Draw_Function is access procedure
           (Hue : in Color);

    type Text_Draw_Function is access procedure
           (X, Y : in Integer;
            Text : in String);

    type Area_Draw_Function is access procedure
           (X, Y, W, H : in Integer);

    Draw_Error : exception;




    ------------------------
    --  No Documentation  --
    ------------------------

    procedure Reset_Spot;

    procedure Set_Spot
           (X, Y, W, H : in Integer;
            Font       : in Font_Kind;
            Size       : in Font_Size);

    procedure Set_Spot
           (X, Y, W, H : in Integer;
            Font       : in Font_Kind;
            Size       : in Font_Size;
            Pane       : in FLTK.Widgets.Groups.Windows.Window'Class);

    procedure Set_Status
           (X, Y, W, H : in Integer);




    ---------------
    --  Utility  --
    ---------------

    function Can_Do_Alpha_Blending
        return Boolean;

    function Shortcut_Label
           (Keys : in Key_Combo)
        return String;




    --------------------------
    --  Charset Conversion  --
    --------------------------

    function Latin1_To_Local
           (From : in String)
        return String;

    function Local_To_Latin1
           (From : in String)
        return String;

    function Mac_Roman_To_Local
           (From : in String)
        return String;

    function Local_To_Mac_Roman
           (From : in String)
        return String;




    ----------------
    --  Clipping  --
    ----------------

    function Clip_Box
           (X, Y, W, H     : in     Integer;
            BX, BY, BW, BH :    out Integer)
        return Boolean;

    function Clip_Intersects
           (X, Y, W, H : in Integer)
        return Boolean;

    procedure Pop_Clip;

    procedure Push_Clip
           (X, Y, W, H : in Integer);

    procedure Push_No_Clip;

    procedure Restore_Clip;




    ---------------
    --  Overlay  --
    ---------------

    procedure Overlay_Clear;

    procedure Overlay_Rect
           (X, Y, W, H : in Integer);




    ----------------
    --  Settings  --
    ----------------

    function Get_Color
        return Color;

    procedure Set_Color
           (To : in Color);

    procedure Set_Color
           (R, G, B : in Color_Component);

    procedure Set_Cursor
           (To : in Mouse_Cursor_Kind);

    procedure Set_Cursor
           (To   : in Mouse_Cursor_Kind;
            Fore : in Color;
            Back : in Color := White_Color);

    function Get_Font
        return Font_Kind;

    function Get_Font_Size
        return Font_Size;

    procedure Set_Font
           (Kind : in Font_Kind;
            Size : in Font_Size);

    function Font_Line_Spacing
        return Integer;

    function Font_Descent
        return Integer;

    function Font_Height
           (Kind : in Font_Kind;
            Size : in Font_Size)
        return Natural;

    procedure Set_Line_Style
           (Line   : in Line_Kind      := Solid_Line;
            Cap    : in Cap_Kind       := Default_Cap;
            Join   : in Join_Kind      := Default_Join;
            Width  : in Natural        := 0;
            Dashes : in Dash_Gap_Array := Empty_Dashes);




    -------------------------
    --  Matrix Operations  --
    -------------------------

    procedure Mult_Matrix
           (A, B, C, D, X, Y : in Long_Float);

    procedure Pop_Matrix;

    procedure Push_Matrix;

    procedure Rotate
           (Angle : in Long_Float);

    procedure Scale
           (Factor : in Long_Float);

    procedure Scale
           (Factor_X, Factor_Y : in Long_Float);

    function Transform_DX
           (X, Y : in Long_Float)
        return Long_Float;

    function Transform_DY
           (X, Y : in Long_Float)
        return Long_Float;

    function Transform_X
           (X, Y : in Long_Float)
        return Long_Float;

    function Transform_Y
           (X, Y : in Long_Float)
        return Long_Float;

    procedure Transformed_Vertex
           (XF, YF : in Long_Float);

    procedure Translate
           (X, Y : in Long_Float);

    procedure Vertex
           (X, Y : in Long_Float);




    ---------------------
    --  Image Drawing  --
    ---------------------

    procedure Draw_Image
           (X, Y, W, H      : in Integer;
            Data            : in Color_Component_Array;
            Depth           : in Positive := 3;
            Line_Data       : in Natural := 0;
            Flip_Horizontal : in Boolean := False;
            Flip_Vertical   : in Boolean := False);

    procedure Draw_Image
           (X, Y, W, H : in Integer;
            Callback   : in Image_Draw_Function;
            Depth      : in Positive := 3);

    procedure Draw_Image_Mono
           (X, Y, W, H      : in Integer;
            Data            : in Color_Component_Array;
            Depth           : in Positive := 1;
            Line_Data       : in Natural := 0;
            Flip_Horizontal : Boolean := False;
            Flip_Vertical   : Boolean := False);

    procedure Draw_Image_Mono
           (X, Y, W, H : in Integer;
            Callback   : in Image_Draw_Function;
            Depth      : in Positive := 1);

    function Read_Image
           (X, Y, W, H : in Integer;
            Alpha      : in Integer := 0)
        return Color_Component_Array
    with Post =>
           (if Alpha = 0
            then Read_Image'Result'Length = W * H * 3
            else Read_Image'Result'Length = W * H * 4);




    -----------------------
    --  Special Drawing  --
    -----------------------

    procedure Add_Symbol
           (Text     : in String;
            Callback : in Symbol_Draw_Function;
            Scalable : in Boolean);

    procedure Draw_Text
           (X, Y : in Integer;
            Text : in String)
    with Pre => Text'Length > 0;

    procedure Draw_Text
           (X, Y, W, H : in Integer;
            Text       : in String;
            Align      : in Alignment;
            Symbols    : in Boolean := True);

    procedure Draw_Text
           (X, Y, W, H : in Integer;
            Text       : in String;
            Align      : in Alignment;
            Picture    : in FLTK.Images.Image'Class;
            Symbols    : in Boolean := True);

    procedure Draw_Text
           (X, Y, W, H : in Integer;
            Text       : in String;
            Align      : in Alignment;
            Callback   : in Text_Draw_Function;
            Symbols    : in Boolean := True);

    procedure Draw_Text
           (X, Y, W, H : in Integer;
            Text       : in String;
            Align      : in Alignment;
            Callback   : in Text_Draw_Function;
            Picture    : in FLTK.Images.Image'Class;
            Symbols    : in Boolean := True);

    procedure Draw_Text
           (X, Y  : in Integer;
            Text  : in String;
            Angle : in Integer);

    procedure Draw_Text_Right_Left
           (X, Y : in Integer;
            Text : in String);

    procedure Draw_Box
           (X, Y, W, H : in Integer;
            Kind       : in Box_Kind;
            Hue        : in Color);

    procedure Draw_Symbol
           (X, Y, W, H : in Integer;
            Name       : in String;
            Hue        : in Color);

    procedure Measure
           (Text    : in     String;
            W, H    :    out Natural;
            Symbols : in     Boolean := True;
            Wrap    : in     Natural := 0);

    procedure Scroll
           (X, Y, W, H : in Integer;
            DX, DY     : in Integer;
            Callback   : in Area_Draw_Function);

    procedure Text_Extents
           (Text         : in     String;
            DX, DY, W, H :    out Integer);

    function Width
           (Text : in String)
        return Long_Float;

    function Width
           (Glyph : in Character)
        return Long_Float;

    function Width
           (Glyph : in Wide_Character)
        return Long_Float;

    function Width
           (Glyph : in Wide_Wide_Character)
        return Long_Float;




    ----------------------
    --  Manual Drawing  --
    ----------------------

    procedure Begin_Complex_Polygon;
    procedure Begin_Line;
    procedure Begin_Loop;
    procedure Begin_Points;
    procedure Begin_Polygon;

    procedure Arc
           (X, Y, R, Start, Finish : in Long_Float);

    procedure Arc
           (X, Y, W, H    : in Integer;
            Start, Finish : in Long_Float);

    --  As per 1.3.9 docs, currently a placeholder
    procedure Chord
           (X, Y, W, H     : in Integer;
            Angle1, Angle2 : in Long_Float);

    procedure Circle
           (X, Y, R : in Long_Float);

    procedure Curve
           (X0, Y0 : in Long_Float;
            X1, Y1 : in Long_Float;
            X2, Y2 : in Long_Float;
            X3, Y3 : in Long_Float);

    procedure Frame
           (X, Y, W, H               : in Integer;
            Top, Left, Bottom, Right : in Greyscale);

    procedure Gap;

    procedure Line
           (X0, Y0 : in Integer;
            X1, Y1 : in Integer);

    procedure Line
           (X0, Y0 : in Integer;
            X1, Y1 : in Integer;
            X2, Y2 : in Integer);

    procedure Outline
           (X0, Y0 : in Integer;
            X1, Y1 : in Integer;
            X2, Y2 : in Integer);

    procedure Outline
           (X0, Y0 : in Integer;
            X1, Y1 : in Integer;
            X2, Y2 : in Integer;
            X3, Y3 : in Integer);

    procedure Pie
           (X, Y, W, H     : in Integer;
            Angle1, Angle2 : in Long_Float);

    procedure Point
           (X, Y : in Integer);

    procedure Polygon
           (X0, Y0 : in Integer;
            X1, Y1 : in Integer;
            X2, Y2 : in Integer);

    procedure Polygon
           (X0, Y0 : in Integer;
            X1, Y1 : in Integer;
            X2, Y2 : in Integer;
            X3, Y3 : in Integer);

    procedure Rect
           (X, Y, W, H : in Integer);

    procedure Rect
           (X, Y, W, H : in Integer;
            Hue        : in Color);

    procedure Rect_Fill
           (X, Y, W, H : in Integer);

    procedure Rect_Fill
           (X, Y, W, H : in Integer;
            Hue        : in Color);

    procedure Rect_Fill
           (X, Y, W, H : in Integer;
            R, G, B    : in Color_Component);

    procedure Ecks_Why_Line
           (X0, Y0, X1 : in Integer);

    procedure Ecks_Why_Line
           (X0, Y0, X1, Y2 : in Integer);

    procedure Ecks_Why_Line
           (X0, Y0, X1, Y2, X3 : in Integer);

    procedure Why_Ecks_Line
           (X0, Y0, Y1 : in Integer);

    procedure Why_Ecks_Line
           (X0, Y0, Y1, X2 : in Integer);

    procedure Why_Ecks_Line
           (X0, Y0, Y1, X2, Y3 : in Integer);

    procedure End_Complex_Polygon;
    procedure End_Line;
    procedure End_Loop;
    procedure End_Points;
    procedure End_Polygon;


private


    pragma Convention (C, Symbol_Draw_Function);


    pragma Inline (Reset_Spot);
    pragma Inline (Set_Spot);
    pragma Inline (Set_Status);


    pragma Inline (Can_Do_Alpha_Blending);
    pragma Inline (Shortcut_Label);


    pragma Inline (Latin1_To_Local);
    pragma Inline (Local_To_Latin1);
    pragma Inline (Mac_Roman_To_Local);
    pragma Inline (Local_To_Mac_Roman);


    pragma Inline (Clip_Intersects);
    pragma Inline (Pop_Clip);
    pragma Inline (Push_Clip);
    pragma Inline (Push_No_Clip);
    pragma Inline (Restore_Clip);


    pragma Inline (Overlay_Clear);
    pragma Inline (Overlay_Rect);


    pragma Inline (Get_Color);
    pragma Inline (Set_Color);
    pragma Inline (Get_Font);
    pragma Inline (Get_Font_Size);
    pragma Inline (Set_Font);
    pragma Inline (Font_Line_Spacing);
    pragma Inline (Font_Descent);
    pragma Inline (Font_Height);


    pragma Inline (Mult_Matrix);
    pragma Inline (Pop_Matrix);
    pragma Inline (Push_Matrix);
    pragma Inline (Rotate);
    pragma Inline (Scale);
    pragma Inline (Transform_DX);
    pragma Inline (Transform_DY);
    pragma Inline (Transform_X);
    pragma Inline (Transform_Y);
    pragma Inline (Transformed_Vertex);
    pragma Inline (Translate);
    pragma Inline (Vertex);


    pragma Inline (Add_Symbol);
    pragma Inline (Draw_Text);
    pragma Inline (Draw_Text_Right_Left);
    pragma Inline (Draw_Box);
    pragma Inline (Draw_Symbol);
    pragma Inline (Measure);
    pragma Inline (Scroll);
    pragma Inline (Text_Extents);
    pragma Inline (Width);


    pragma Inline (Begin_Complex_Polygon);
    pragma Inline (Begin_Line);
    pragma Inline (Begin_Loop);
    pragma Inline (Begin_Points);
    pragma Inline (Begin_Polygon);


    pragma Inline (Arc);
    pragma Inline (Chord);
    pragma Inline (Circle);
    pragma Inline (Curve);
    pragma Inline (Frame);
    pragma Inline (Gap);
    pragma Inline (Line);
    pragma Inline (Outline);
    pragma Inline (Pie);
    pragma Inline (Point);
    pragma Inline (Polygon);
    pragma Inline (Rect);
    pragma Inline (Rect_Fill);
    pragma Inline (Ecks_Why_Line);
    pragma Inline (Why_Ecks_Line);


    pragma Inline (End_Complex_Polygon);
    pragma Inline (End_Line);
    pragma Inline (End_Loop);
    pragma Inline (End_Points);
    pragma Inline (End_Polygon);


end FLTK.Draw;