rom/hidds/graphics/GC_Class.c

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