src/stc/scintilla/include/Platform.h

   1 // Scintilla source code edit control
   2 /** @file Platform.h
   3  ** Interface to platform facilities. Also includes some basic utilities.
   4  ** Implemented in PlatGTK.cxx for GTK+/Linux, PlatWin.cxx for Windows, and PlatWX.cxx for wxWindows.
   5  **/
   6 // Copyright 1998-2003 by Neil Hodgson <neilh@scintilla.org>
   7 // The License.txt file describes the conditions under which this software may be distributed.
   8
   9 #ifndef PLATFORM_H
  10 #define PLATFORM_H
  11
  12 // PLAT_GTK = GTK+ on Linux or Win32
  13 // PLAT_GTK_WIN32 is defined additionally when running PLAT_GTK under Win32
  14 // PLAT_WIN = Win32 API on Win32 OS
  15 // PLAT_WX is wxWindows on any supported platform
  16
  17 #define PLAT_GTK 0
  18 #define PLAT_GTK_WIN32 0
  19 #define PLAT_WIN 0
  20 #define PLAT_WX  0
  21 #define PLAT_FOX 0
  22
  23 #if defined(FOX)
  24 #undef PLAT_FOX
  25 #define PLAT_FOX 1
  26
  27 #elif defined(__WX__)
  28 #undef PLAT_WX
  29 #define PLAT_WX  1
  30
  31 #elif defined(GTK)
  32 #undef PLAT_GTK
  33 #define PLAT_GTK 1
  34
  35 #ifdef _MSC_VER
  36 #undef PLAT_GTK_WIN32
  37 #define PLAT_GTK_WIN32 1
  38 #endif
  39
  40 #else
  41 #undef PLAT_WIN
  42 #define PLAT_WIN 1
  43
  44 #endif
  45
  46
  47 #if PLAT_WX
  48 #include <wx/object.h>  // For the global memory operators, if needed.
  49 #endif
  50
  51
  52 // Underlying the implementation of the platform classes are platform specific types.
  53 // Sometimes these need to be passed around by client code so they are defined here
  54
  55 typedef void *FontID;
  56 typedef void *SurfaceID;
  57 typedef void *WindowID;
  58 typedef void *MenuID;
  59 typedef void *TickerID;
  60 typedef void *Function;
  61
  62 /**
  63  * A geometric point class.
  64  * Point is exactly the same as the Win32 POINT and GTK+ GdkPoint so can be used interchangeably.
  65  */
  66 class Point {
  67 public:
  68         int x;
  69         int y;
  70
  71         Point(int x_=0, int y_=0) : x(x_), y(y_) {
  72         }
  73
  74         // Other automatically defined methods (assignment, copy constructor, destructor) are fine
  75
  76         static Point FromLong(long lpoint);
  77 };
  78
  79 /**
  80  * A geometric rectangle class.
  81  * PRectangle is exactly the same as the Win32 RECT so can be used interchangeably.
  82  * PRectangles contain their top and left sides, but not their right and bottom sides.
  83  */
  84 class PRectangle {
  85 public:
  86         int left;
  87         int top;
  88         int right;
  89         int bottom;
  90
  91         PRectangle(int left_=0, int top_=0, int right_=0, int bottom_ = 0) :
  92                 left(left_), top(top_), right(right_), bottom(bottom_) {
  93         }
  94
  95         // Other automatically defined methods (assignment, copy constructor, destructor) are fine
  96
  97         bool operator==(PRectangle &rc) {
  98                 return (rc.left == left) && (rc.right == right) &&
  99                         (rc.top == top) && (rc.bottom == bottom);
 100         }
 101         bool Contains(Point pt) {
 102                 return (pt.x >= left) && (pt.x <= right) &&
 103                         (pt.y >= top) && (pt.y <= bottom);
 104         }
 105         bool Contains(PRectangle rc) {
 106                 return (rc.left >= left) && (rc.right <= right) &&
 107                         (rc.top >= top) && (rc.bottom <= bottom);
 108         }
 109         bool Intersects(PRectangle other) {
 110                 return (right > other.left) && (left < other.right) &&
 111                         (bottom > other.top) && (top < other.bottom);
 112         }
 113         void Move(int xDelta, int yDelta) {
 114                 left += xDelta;
 115                 top += yDelta;
 116                 right += xDelta;
 117                 bottom += yDelta;
 118         }
 119         int Width() { return right - left; }
 120         int Height() { return bottom - top; }
 121 };
 122
 123 /**
 124  * In some circumstances, including Win32 in paletted mode and GTK+, each colour
 125  * must be allocated before use. The desired colours are held in the ColourDesired class,
 126  * and after allocation the allocation entry is stored in the ColourAllocated class. In other
 127  * circumstances, such as Win32 in true colour mode, the allocation process just copies
 128  * the RGB values from the desired to the allocated class.
 129  * As each desired colour requires allocation before it can be used, the ColourPair class
 130  * holds both a ColourDesired and a ColourAllocated
 131  * The Palette class is responsible for managing the palette of colours which contains a
 132  * list of ColourPair objects and performs the allocation.
 133  */
 134
 135 /**
 136  * Holds a desired RGB colour.
 137  */
 138 class ColourDesired {
 139         long co;
 140 public:
 141         ColourDesired(long lcol=0) {
 142                 co = lcol;
 143         }
 144
 145         ColourDesired(unsigned int red, unsigned int green, unsigned int blue) {
 146                 Set(red, green, blue);
 147         }
 148
 149         bool operator==(const ColourDesired &other) const {
 150                 return co == other.co;
 151         }
 152
 153         void Set(long lcol) {
 154                 co = lcol;
 155         }
 156
 157         void Set(unsigned int red, unsigned int green, unsigned int blue) {
 158                 co = red | (green << 8) | (blue << 16);
 159         }
 160
 161         static inline unsigned int ValueOfHex(const char ch) {
 162                 if (ch >= '0' && ch <= '9')
 163                         return ch - '0';
 164                 else if (ch >= 'A' && ch <= 'F')
 165                         return ch - 'A' + 10;
 166                 else if (ch >= 'a' && ch <= 'f')
 167                         return ch - 'a' + 10;
 168                 else
 169                         return 0;
 170         }
 171
 172         void Set(const char *val) {
 173                 if (*val == '#') {
 174                         val++;
 175                 }
 176                 unsigned int r = ValueOfHex(val[0]) * 16 + ValueOfHex(val[1]);
 177                 unsigned int g = ValueOfHex(val[2]) * 16 + ValueOfHex(val[3]);
 178                 unsigned int b = ValueOfHex(val[4]) * 16 + ValueOfHex(val[5]);
 179                 Set(r, g, b);
 180         }
 181
 182         long AsLong() const {
 183                 return co;
 184         }
 185
 186         unsigned int GetRed() {
 187                 return co & 0xff;
 188         }
 189
 190         unsigned int GetGreen() {
 191                 return (co >> 8) & 0xff;
 192         }
 193
 194         unsigned int GetBlue() {
 195                 return (co >> 16) & 0xff;
 196         }
 197 };
 198
 199 /**
 200  * Holds an allocated RGB colour which may be an approximation to the desired colour.
 201  */
 202 class ColourAllocated {
 203         long coAllocated;
 204
 205 public:
 206
 207         ColourAllocated(long lcol=0) {
 208                 coAllocated = lcol;
 209         }
 210
 211         void Set(long lcol) {
 212                 coAllocated = lcol;
 213         }
 214
 215         long AsLong() const {
 216                 return coAllocated;
 217         }
 218 };
 219
 220 /**
 221  * Colour pairs hold a desired colour and an allocated colour.
 222  */
 223 struct ColourPair {
 224         ColourDesired desired;
 225         ColourAllocated allocated;
 226
 227         ColourPair(ColourDesired desired_=ColourDesired(0,0,0)) {
 228                 desired = desired_;
 229                 allocated.Set(desired.AsLong());
 230         }
 231         void Copy() {
 232                 allocated.Set(desired.AsLong());
 233         }
 234 };
 235
 236 class Window;   // Forward declaration for Palette
 237
 238 /**
 239  * Colour palette management.
 240  */
 241 class Palette {
 242         int used;
 243         enum {numEntries = 100};
 244         ColourPair entries[numEntries];
 245 #if PLAT_GTK
 246         void *allocatedPalette; // GdkColor *
 247         int allocatedLen;
 248 #endif
 249 public:
 250 #if PLAT_WIN
 251         void *hpal;
 252 #endif
 253         bool allowRealization;
 254
 255         Palette();
 256         ~Palette();
 257
 258         void Release();
 259
 260         /**
 261          * This method either adds a colour to the list of wanted colours (want==true)
 262          * or retrieves the allocated colour back to the ColourPair.
 263          * This is one method to make it easier to keep the code for wanting and retrieving in sync.
 264          */
 265         void WantFind(ColourPair &cp, bool want);
 266
 267         void Allocate(Window &w);
 268 };
 269
 270 /**
 271  * Font management.
 272  */
 273 class Font {
 274 protected:
 275         FontID id;
 276 #if PLAT_WX
 277         int ascent;
 278 #endif
 279         // Private so Font objects can not be copied
 280         Font(const Font &) {}
 281         Font &operator=(const Font &) { id=0; return *this; }
 282 public:
 283         Font();
 284         virtual ~Font();
 285
 286         virtual void Create(const char *faceName, int characterSet, int size, bool bold, bool italic);
 287         virtual void Release();
 288
 289         FontID GetID() { return id; }
 290         // Alias another font - caller guarantees not to Release
 291         void SetID(FontID id_) { id = id_; }
 292         friend class Surface;
 293         friend class SurfaceImpl;
 294 };
 295
 296 /**
 297  * A surface abstracts a place to draw.
 298  */
 299 class Surface {
 300 private:
 301         // Private so Surface objects can not be copied
 302         Surface(const Surface &) {}
 303         Surface &operator=(const Surface &) { return *this; }
 304 public:
 305         Surface() {};
 306         virtual ~Surface() {};
 307         static Surface *Allocate();
 308
 309         virtual void Init(WindowID wid)=0;
 310         virtual void Init(SurfaceID sid, WindowID wid)=0;
 311         virtual void InitPixMap(int width, int height, Surface *surface_, WindowID wid)=0;
 312
 313         virtual void Release()=0;
 314         virtual bool Initialised()=0;
 315         virtual void PenColour(ColourAllocated fore)=0;
 316         virtual int LogPixelsY()=0;
 317         virtual int DeviceHeightFont(int points)=0;
 318         virtual void MoveTo(int x_, int y_)=0;
 319         virtual void LineTo(int x_, int y_)=0;
 320         virtual void Polygon(Point *pts, int npts, ColourAllocated fore, ColourAllocated back)=0;
 321         virtual void RectangleDraw(PRectangle rc, ColourAllocated fore, ColourAllocated back)=0;
 322         virtual void FillRectangle(PRectangle rc, ColourAllocated back)=0;
 323         virtual void FillRectangle(PRectangle rc, Surface &surfacePattern)=0;
 324         virtual void RoundedRectangle(PRectangle rc, ColourAllocated fore, ColourAllocated back)=0;
 325         virtual void Ellipse(PRectangle rc, ColourAllocated fore, ColourAllocated back)=0;
 326         virtual void Copy(PRectangle rc, Point from, Surface &surfaceSource)=0;
 327
 328         virtual void DrawTextNoClip(PRectangle rc, Font &font_, int ybase, const char *s, int len, ColourAllocated fore, ColourAllocated back)=0;
 329         virtual void DrawTextClipped(PRectangle rc, Font &font_, int ybase, const char *s, int len, ColourAllocated fore, ColourAllocated back)=0;
 330         virtual void DrawTextTransparent(PRectangle rc, Font &font_, int ybase, const char *s, int len, ColourAllocated fore)=0;
 331         virtual void MeasureWidths(Font &font_, const char *s, int len, int *positions)=0;
 332         virtual int WidthText(Font &font_, const char *s, int len)=0;
 333         virtual int WidthChar(Font &font_, char ch)=0;
 334         virtual int Ascent(Font &font_)=0;
 335         virtual int Descent(Font &font_)=0;
 336         virtual int InternalLeading(Font &font_)=0;
 337         virtual int ExternalLeading(Font &font_)=0;
 338         virtual int Height(Font &font_)=0;
 339         virtual int AverageCharWidth(Font &font_)=0;
 340
 341         virtual int SetPalette(Palette *pal, bool inBackGround)=0;
 342         virtual void SetClip(PRectangle rc)=0;
 343         virtual void FlushCachedState()=0;
 344
 345         virtual void SetUnicodeMode(bool unicodeMode_)=0;
 346         virtual void SetDBCSMode(int codePage)=0;
 347 };
 348
 349 /**
 350  * A simple callback action passing one piece of untyped user data.
 351  */
 352 typedef void (*CallBackAction)(void*);
 353
 354 /**
 355  * Class to hide the details of window manipulation.
 356  * Does not own the window which will normally have a longer life than this object.
 357  */
 358 class Window {
 359 protected:
 360         WindowID id;
 361 public:
 362         Window() : id(0), cursorLast(cursorInvalid) {}
 363         Window(const Window &source) : id(source.id), cursorLast(cursorInvalid) {}
 364         virtual ~Window();
 365         Window &operator=(WindowID id_) {
 366                 id = id_;
 367                 return *this;
 368         }
 369         WindowID GetID() const { return id; }
 370         bool Created() const { return id != 0; }
 371         void Destroy();
 372         bool HasFocus();
 373         PRectangle GetPosition();
 374         void SetPosition(PRectangle rc);
 375         void SetPositionRelative(PRectangle rc, Window relativeTo);
 376         PRectangle GetClientPosition();
 377         void Show(bool show=true);
 378         void InvalidateAll();
 379         void InvalidateRectangle(PRectangle rc);
 380         virtual void SetFont(Font &font);
 381         enum Cursor { cursorInvalid, cursorText, cursorArrow, cursorUp, cursorWait, cursorHoriz, cursorVert, cursorReverseArrow, cursorHand };
 382         void SetCursor(Cursor curs);
 383         void SetTitle(const char *s);
 384 private:
 385         Cursor cursorLast;
 386 };
 387
 388 /**
 389  * Listbox management.
 390  */
 391
 392 class ListBox : public Window {
 393 public:
 394         ListBox();
 395         virtual ~ListBox();
 396         static ListBox *Allocate();
 397
 398         virtual void SetFont(Font &font)=0;
 399         virtual void Create(Window &parent, int ctrlID, int lineHeight_, bool unicodeMode_)=0;
 400         virtual void SetAverageCharWidth(int width)=0;
 401         virtual void SetVisibleRows(int rows)=0;
 402         virtual PRectangle GetDesiredRect()=0;
 403         virtual int CaretFromEdge()=0;
 404         virtual void Clear()=0;
 405         virtual void Append(char *s, int type = -1)=0;
 406         virtual int Length()=0;
 407         virtual void Select(int n)=0;
 408         virtual int GetSelection()=0;
 409         virtual int Find(const char *prefix)=0;
 410         virtual void GetValue(int n, char *value, int len)=0;
 411         virtual void Sort()=0;
 412         virtual void RegisterImage(int type, const char *xpm_data)=0;
 413         virtual void ClearRegisteredImages()=0;
 414         virtual void SetDoubleClickAction(CallBackAction, void *)=0;
 415 };
 416
 417 /**
 418  * Menu management.
 419  */
 420 class Menu {
 421         MenuID id;
 422 public:
 423         Menu();
 424         MenuID GetID() { return id; }
 425         void CreatePopUp();
 426         void Destroy();
 427         void Show(Point pt, Window &w);
 428 };
 429
 430 class ElapsedTime {
 431         long bigBit;
 432         long littleBit;
 433 public:
 434         ElapsedTime();
 435         double Duration(bool reset=false);
 436 };
 437
 438 /**
 439  * Dynamic Library (DLL/SO/...) loading
 440  */
 441 class DynamicLibrary {
 442 public:
 443         virtual ~DynamicLibrary() {};
 444
 445         /// @return Pointer to function "name", or NULL on failure.
 446         virtual Function FindFunction(const char *name) = 0;
 447
 448         /// @return true if the library was loaded successfully.
 449         virtual bool IsValid() = 0;
 450
 451         /// @return An instance of a DynamicLibrary subclass with "modulePath" loaded.
 452         static DynamicLibrary *Load(const char *modulePath);
 453 };
 454
 455 /**
 456  * Platform class used to retrieve system wide parameters such as double click speed
 457  * and chrome colour. Not a creatable object, more of a module with several functions.
 458  */
 459 class Platform {
 460         // Private so Platform objects can not be copied
 461         Platform(const Platform &) {}
 462         Platform &operator=(const Platform &) { return *this; }
 463 public:
 464         // Should be private because no new Platforms are ever created
 465         // but gcc warns about this
 466         Platform() {}
 467         ~Platform() {}
 468         static ColourDesired Chrome();
 469         static ColourDesired ChromeHighlight();
 470         static const char *DefaultFont();
 471         static int DefaultFontSize();
 472         static unsigned int DoubleClickTime();
 473         static bool MouseButtonBounce();
 474         static void DebugDisplay(const char *s);
 475         static bool IsKeyDown(int key);
 476         static long SendScintilla(
 477                 WindowID w, unsigned int msg, unsigned long wParam=0, long lParam=0);
 478         static long SendScintillaPointer(
 479                 WindowID w, unsigned int msg, unsigned long wParam=0, void *lParam=0);
 480         static bool IsDBCSLeadByte(int codePage, char ch);
 481         static int DBCSCharLength(int codePage, const char *s);
 482         static int DBCSCharMaxLength();
 483
 484         // These are utility functions not really tied to a platform
 485         static int Minimum(int a, int b);
 486         static int Maximum(int a, int b);
 487         // Next three assume 16 bit shorts and 32 bit longs
 488         static long LongFromTwoShorts(short a,short b) {
 489                 return (a) | ((b) << 16);
 490         }
 491         static short HighShortFromLong(long x) {
 492                 return static_cast<short>(x >> 16);
 493         }
 494         static short LowShortFromLong(long x) {
 495                 return static_cast<short>(x & 0xffff);
 496         }
 497         static void DebugPrintf(const char *format, ...);
 498         static bool ShowAssertionPopUps(bool assertionPopUps_);
 499         static void Assert(const char *c, const char *file, int line);
 500         static int Clamp(int val, int minVal, int maxVal);
 501 };
 502
 503 #ifdef  NDEBUG
 504 #define PLATFORM_ASSERT(c) ((void)0)
 505 #else
 506 #define PLATFORM_ASSERT(c) ((c) ? (void)(0) : Platform::Assert(#c, __FILE__, __LINE__))
 507 #endif
 508
 509 // Shut up annoying Visual C++ warnings:
 510 #ifdef _MSC_VER
 511 #pragma warning(disable: 4244 4309 4514 4710)
 512 #endif
 513
 514 #endif