rom/hidds/graphics/gfx_gcclass.c

   1 /*
   2     Copyright © 1995-2017, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Graphics gc class implementation.
   6     Lang: english
   7 */
   8
   9 /****************************************************************************************/
  10
  11 #include "gfx_debug.h"
  12
  13 #include <string.h>
  14
  15 #include <proto/exec.h>
  16 #include <proto/utility.h>
  17 #include <proto/oop.h>
  18
  19 #include <exec/memory.h>
  20 #include <graphics/text.h>
  21 #include <utility/tagitem.h>
  22 #include <oop/oop.h>
  23
  24 #include <hidd/gfx.h>
  25
  26 #include "gfx_intern.h"
  27
  28 /*****************************************************************************************
  29
  30     NAME
  31         aoHidd_GC_Foreground
  32
  33     SYNOPSIS
  34         [.SG]
  35
  36     LOCATION
  37         hidd.gfx.gc
  38
  39     FUNCTION
  40         Foreground color
  41
  42     NOTES
  43
  44     EXAMPLE
  45
  46     BUGS
  47
  48     SEE ALSO
  49
  50     INTERNALS
  51
  52 *****************************************************************************************/
  53
  54 /*****************************************************************************************
  55
  56     NAME
  57         aoHidd_GC_Background
  58
  59     SYNOPSIS
  60         [.SG]
  61
  62     LOCATION
  63         hidd.gfx.gc
  64
  65     FUNCTION
  66         Background color
  67
  68     NOTES
  69
  70     EXAMPLE
  71
  72     BUGS
  73
  74     SEE ALSO
  75
  76     INTERNALS
  77
  78 *****************************************************************************************/
  79
  80 /*****************************************************************************************
  81
  82     NAME
  83         aoHidd_GC_DrawMode
  84
  85     SYNOPSIS
  86         [.SG]
  87
  88     LOCATION
  89         hidd.gfx.gc
  90
  91     FUNCTION
  92         Draw mode
  93
  94     NOTES
  95
  96     EXAMPLE
  97
  98     BUGS
  99
 100     SEE ALSO
 101
 102     INTERNALS
 103
 104 *****************************************************************************************/
 105
 106 /*****************************************************************************************
 107
 108     NAME
 109         aoHidd_GC_ColorMask
 110
 111     SYNOPSIS
 112         [.SG]
 113
 114     LOCATION
 115         hidd.gfx.gc
 116
 117     FUNCTION
 118         Prevents some color bits from changing.
 119
 120     NOTES
 121
 122     EXAMPLE
 123
 124     BUGS
 125
 126     SEE ALSO
 127
 128     INTERNALS
 129
 130 *****************************************************************************************/
 131
 132 /*****************************************************************************************
 133
 134     NAME
 135         aoHidd_GC_LinePattern
 136
 137     SYNOPSIS
 138         [.SG]
 139
 140     LOCATION
 141         hidd.gfx.gc
 142
 143     FUNCTION
 144         Pattern for line drawing
 145
 146     NOTES
 147
 148     EXAMPLE
 149
 150     BUGS
 151
 152     SEE ALSO
 153
 154     INTERNALS
 155
 156 *****************************************************************************************/
 157
 158 /*****************************************************************************************
 159
 160     NAME
 161         aoHidd_GC_LinePatternCnt
 162
 163     SYNOPSIS
 164         [.SG]
 165
 166     LOCATION
 167         hidd.gfx.gc
 168
 169     FUNCTION
 170         Pattern start bit for line drawing.
 171
 172     NOTES
 173
 174     EXAMPLE
 175
 176     BUGS
 177
 178     SEE ALSO
 179
 180     INTERNALS
 181
 182 *****************************************************************************************/
 183
 184 /*****************************************************************************************
 185
 186     NAME
 187         aoHidd_GC_ColorExpansionMode
 188
 189     SYNOPSIS
 190         [.SG]
 191
 192     LOCATION
 193         hidd.gfx.gc
 194
 195     FUNCTION
 196         Mode for color expansion
 197
 198     NOTES
 199
 200     EXAMPLE
 201
 202     BUGS
 203
 204     SEE ALSO
 205
 206     INTERNALS
 207
 208 *****************************************************************************************/
 209
 210 VOID GC__Root__Set(OOP_Class *cl, OOP_Object *obj, struct pRoot_Set *msg);
 211
 212 #define IS_GC_ATTR(attr, idx) ( ( (idx) = (attr) - HiddGCAttrBase) < num_Hidd_GC_Attrs)
 213
 214 /****************************************************************************************/
 215
 216 OOP_Object *GC__Root__New(OOP_Class *cl, OOP_Object *obj, struct pRoot_New *msg)
 217 {
 218     struct Library *OOPBase = CSD(cl)->cs_OOPBase;
 219     HIDDT_GC_Intern *data;
 220
 221     EnterFunc(bug("GC::New()\n"));
 222
 223     obj  = (OOP_Object *) OOP_DoSuperMethod(cl, obj, (OOP_Msg) msg);
 224
 225     if(obj)
 226     {
 227         data = OOP_INST_DATA(cl, obj);
 228
 229         /* clear all data and set some default values */
 230         data->fg        = 1;        /* foreground color                        */
 231         data->bg        = 0;        /* background color                        */
 232         data->drMode    = vHidd_GC_DrawMode_Copy;    /* drawmode               */
 233         data->colExp    = vHidd_GC_ColExp_Opaque;    /* color expansion mode   */
 234         data->colMask   = ~0;       /* ColorMask prevents some color bits from changing*/
 235         data->linePat   = ~0;       /* LinePattern                             */
 236
 237         /* Override defaults with user suplied attrs */
 238
 239         OOP_SetAttrs(obj, msg->attrList);
 240         /* GC__Root__Set(cl, obj, &set_msg); */
 241
 242     } /* if(obj) */
 243
 244     ReturnPtr("GC::New", OOP_Object *, obj);
 245 }
 246
 247 /****************************************************************************************/
 248
 249 VOID GC__Root__Set(OOP_Class *cl, OOP_Object *obj, struct pRoot_Set *msg)
 250 {
 251     struct Library *UtilityBase = CSD(cl)->cs_UtilityBase;
 252     HIDDT_GC_Intern *data = OOP_INST_DATA(cl, obj);
 253     struct TagItem  *tag, *tstate;
 254     ULONG           idx;
 255
 256     EnterFunc(bug("GC::Set()\n"));
 257
 258     tstate = msg->attrList;
 259     while((tag = NextTagItem(&tstate)))
 260     {
 261         if(IS_GC_ATTR(tag->ti_Tag, idx))
 262         {
 263             switch(idx)
 264             {
 265                 case aoHidd_GC_Foreground:
 266                     data->fg = tag->ti_Data;
 267                     break;
 268
 269                 case aoHidd_GC_Background:
 270                     data->bg = tag->ti_Data;
 271                     break;
 272
 273                 case aoHidd_GC_DrawMode:
 274                     data->drMode = tag->ti_Data;
 275                     break;
 276
 277                 case aoHidd_GC_ColorMask:
 278                     data->colMask = tag->ti_Data;
 279                     break;
 280
 281                 case aoHidd_GC_LinePattern:
 282                     data->linePat = (UWORD) tag->ti_Data;
 283                     break;
 284
 285                 case aoHidd_GC_LinePatternCnt:
 286                     data->linePatCnt = (UWORD) tag->ti_Data;
 287                     break;
 288
 289                 case aoHidd_GC_ColorExpansionMode:
 290                     data->colExp = tag->ti_Data;
 291                     break;
 292             }
 293         }
 294     }
 295
 296     ReturnVoid("GC::Set");
 297 }
 298
 299 /****************************************************************************************/
 300
 301 VOID GC__Root__Get(OOP_Class *cl, OOP_Object *obj, struct pRoot_Get *msg)
 302 {
 303     HIDDT_GC_Intern *data = OOP_INST_DATA(cl, obj);
 304     ULONG           idx;
 305
 306     EnterFunc(bug("GC::Get() attrID: %i  storage: %p\n", msg->attrID, msg->storage));
 307
 308     if(IS_GC_ATTR(msg->attrID, idx))
 309     {
 310         switch(idx)
 311         {
 312             case aoHidd_GC_Foreground:
 313                  *msg->storage = data->fg;
 314                  break;
 315
 316             case aoHidd_GC_Background:
 317                  *msg->storage = data->bg;
 318                  break;
 319
 320             case aoHidd_GC_DrawMode:
 321                 *msg->storage = data->drMode;
 322                 break;
 323
 324             case aoHidd_GC_ColorMask:
 325                 *msg->storage = data->colMask;
 326                 break;
 327
 328             case aoHidd_GC_LinePattern:
 329                 *msg->storage = data->linePat;
 330                 break;
 331
 332             case aoHidd_GC_LinePatternCnt:
 333                 *msg->storage = data->linePatCnt;
 334                 break;
 335
 336             case aoHidd_GC_ColorExpansionMode:
 337                 *msg->storage = data->colExp;
 338                 break;
 339
 340             default:
 341                 OOP_DoSuperMethod(cl, obj, (OOP_Msg) msg);
 342                 break;
 343         }
 344     }
 345     else
 346     {
 347         OOP_DoSuperMethod(cl, obj, (OOP_Msg) msg);
 348     }
 349
 350 }
 351
 352 /*****************************************************************************************
 353
 354     NAME
 355         moHidd_GC_SetClipRect
 356
 357     SYNOPSIS
 358         VOID OOP_DoMethod(OOP_Object *obj, struct pHidd_GC_SetClipRect *msg);
 359
 360         VOID HIDD_GC_SetClipRect(OOP_Object *obj, LONG x1, LONG y1, LONG x2, LONG y2);
 361
 362     LOCATION
 363         hidd.gfx.gc
 364
 365     FUNCTION
 366         Install a clipping rectangle on a GC.
 367
 368     INPUTS
 369         obj    - a GC object
 370         x1, y1 - top-left coordinate of the clipping rectangle
 371         x2, y2 - bottom-right coordinate of the clipping rectangle
 372
 373     RESULT
 374         None
 375
 376     NOTES
 377         Since the GC is just a data container, installing clipping rectangle doesn't magically
 378         applies it to all operations. Graphics driver method which uses the GC needs to support
 379         it explicitly. Currently clipping is supported only by Draw and DrawEllipse methods.
 380
 381         Use this method if and only if the GC object was created by you. graphics.library
 382         internally operates on temporary GC objects, which are allocated only partially. They
 383         don't have storage space for clipping rectangle data, and attempt to use this
 384         method on such a GC will result in memory trashing.
 385
 386     EXAMPLE
 387
 388     BUGS
 389
 390     SEE ALSO
 391
 392     INTERNALS
 393
 394 *****************************************************************************************/
 395
 396 VOID GC__Hidd_GC__SetClipRect(OOP_Class *cl, OOP_Object *o, struct pHidd_GC_SetClipRect *msg)
 397 {
 398      struct gc_data *data = OOP_INST_DATA(cl, o);
 399
 400      /* A space for struct Rectangle has been allocated together with the object */
 401      data->cr.MinX = msg->x1;
 402      data->cr.MinY = msg->y1;
 403      data->cr.MaxX = msg->x2;
 404      data->cr.MaxY = msg->y2;
 405
 406      /*
 407       * Set clipRect pointer to our own rectangle.
 408       * clipRect is intentionally a pointer, not embedded structure. This is done
 409       * in order to support temporary GCs embedded in a RastPort for graphics.library.
 410       * There's not enough space to hold struct Rectangle in embedded GC.
 411       */
 412      data->prot.clipRect = &data->cr;
 413 }
 414
 415 /*****************************************************************************************
 416
 417     NAME
 418         moHidd_GC_UnsetClipRect
 419
 420     SYNOPSIS
 421         VOID OOP_DoMethod(OOP_Object *obj, struct pHidd_GC_UnsetClipRect *msg);
 422
 423         VOID HIDD_GC_UnsetClipRect(OOP_Object *obj);
 424
 425     LOCATION
 426         hidd.gfx.gc
 427
 428     FUNCTION
 429         Uninstalls the clipping rectangle (whatever it is) from the GC.
 430
 431     INPUTS
 432         obj - a GC object
 433
 434     RESULT
 435         None
 436
 437     NOTES
 438
 439     EXAMPLE
 440
 441     BUGS
 442
 443     SEE ALSO
 444
 445     INTERNALS
 446
 447 *****************************************************************************************/
 448
 449 VOID GC__Hidd_GC__UnsetClipRect(OOP_Class *cl, OOP_Object *o, struct pHidd_GC_UnsetClipRect *msg)
 450 {
 451      HIDDT_GC_Intern *data = OOP_INST_DATA(cl, o);
 452
 453      /* Reset clipRect pointer */
 454      data->clipRect = NULL;
 455 }