Shamusworld >> Repos - apple2/blob - src/gui/gui.cpp

   1 //
   2 // gui.cpp
   3 //
   4 // Graphical User Interface support
   5 // by James Hammons
   6 // © 2014 Underground Software
   7 //
   8 // JLH = James Hammons <jlhamm@acm.org>
   9 //
  10 // WHO  WHEN        WHAT
  11 // ---  ----------  ------------------------------------------------------------
  12 // JLH  02/03/2006  Created this file
  13 // JLH  03/13/2006  Added functions to allow shutting down GUI externally
  14 // JLH  03/22/2006  Finalized basic multiple window support
  15 // JLH  03/03/2014  Refactored GUI to use SDL 2, more modern approach as well
  16 //
  17 // STILL TO DO:
  18 //
  19 // - Memory leak on quitting with a window active [DONE]
  20 // - Multiple window handling [DONE]
  21 //
  22
  23 #include "gui.h"
  24 #include "apple2.h"
  25 #include "applevideo.h"
  26 #include "diskselector.h"
  27 #include "log.h"
  28 #include "video.h"
  29
  30 // Icons, in GIMP "C" format
  31 #include "gfx/icon-selection.c"
  32 #include "gfx/disk-icon.c"
  33 #include "gfx/power-off-icon.c"
  34 #include "gfx/power-on-icon.c"
  35 #include "gfx/disk-swap-icon.c"
  36 #include "gfx/disk-door-open.c"
  37 #include "gfx/disk-door-closed.c"
  38 #include "gfx/save-state-icon.c"
  39 #include "gfx/load-state-icon.c"
  40 #include "gfx/config-icon.c"
  41
  42
  43 // Okay, this is ugly but works and I can't think of any better way to handle
  44 // this. So what we do when we pass the GIMP bitmaps into a function is pass
  45 // them as a (void *) and then cast them as type (Bitmap *) in order to use
  46 // them. Yes, it's ugly. Come up with something better!
  47
  48 struct Bitmap {
  49         unsigned int width;
  50         unsigned int height;
  51         unsigned int bytesPerPixel;                                     // 3:RGB, 4:RGBA
  52         unsigned char pixelData[];
  53 };
  54
  55
  56 const char numeralOne[(7 * 7) + 1] =
  57         "  @@   "
  58         " @@@   "
  59         "@@@@   "
  60         "  @@   "
  61         "  @@   "
  62         "  @@   "
  63         "@@@@@@ ";
  64
  65 const char numeralTwo[(7 * 7) + 1] =
  66         " @@@@@ "
  67         "@@   @@"
  68         "    @@@"
  69         "  @@@@ "
  70         " @@@   "
  71         "@@     "
  72         "@@@@@@@";
  73
  74 const char ejectIcon[(8 * 7) + 1] =
  75         "   @@   "
  76         "  @@@@  "
  77         " @@@@@@ "
  78         "@@@@@@@@"
  79         "        "
  80         "@@@@@@@@"
  81         "@@@@@@@@";
  82
  83 const char driveLight[(5 * 5) + 1] =
  84         " @@@ "
  85         "@@@@@"
  86         "@@@@@"
  87         "@@@@@"
  88         " @@@ ";
  89
  90
  91 enum { SBS_SHOWING, SBS_HIDING, SBS_SHOWN, SBS_HIDDEN };
  92
  93
  94 SDL_Texture * GUI::overlay = NULL;
  95 SDL_Rect GUI::olDst;
  96 int GUI::sidebarState = SBS_HIDDEN;
  97 int32_t GUI::dx = 0;
  98 int32_t GUI::iconSelected = -1;
  99 bool GUI::hasKeyboardFocus = false;
 100 bool GUI::powerOnState = true;
 101
 102 int32_t lastIconSelected = -1;
 103 SDL_Texture * iconSelection = NULL;
 104 SDL_Texture * diskIcon = NULL;
 105 SDL_Texture * disk1Icon = NULL;
 106 SDL_Texture * disk2Icon = NULL;
 107 SDL_Texture * powerOnIcon = NULL;
 108 SDL_Texture * powerOffIcon = NULL;
 109 SDL_Texture * diskSwapIcon = NULL;
 110 SDL_Texture * stateSaveIcon = NULL;
 111 SDL_Texture * stateLoadIcon = NULL;
 112 SDL_Texture * configIcon = NULL;
 113 SDL_Texture * doorOpen = NULL;
 114 SDL_Texture * doorClosed = NULL;
 115 uint32_t texturePointer[128 * 380];
 116 const char iconHelp[7][80] = { "Turn emulated Apple off/on",
 117         "Insert floppy image into drive #1", "Insert floppy image into drive #2",
 118         "Swap disks", "Save emulator state", "Load emulator state",
 119         "Configure Apple2" };
 120 bool disk1EjectHovered = false;
 121 bool disk2EjectHovered = false;
 122
 123
 124 #define SIDEBAR_X_POS  (VIRTUAL_SCREEN_WIDTH - 80)
 125
 126
 127 GUI::GUI(void)
 128 {
 129 }
 130
 131
 132 GUI::~GUI(void)
 133 {
 134 }
 135
 136
 137 void GUI::Init(SDL_Renderer * renderer)
 138 {
 139         overlay = SDL_CreateTexture(renderer, SDL_PIXELFORMAT_ABGR8888,
 140                 SDL_TEXTUREACCESS_TARGET, 128, 380);
 141
 142         if (!overlay)
 143         {
 144                 WriteLog("GUI: Could not create overlay!\n");
 145                 return;
 146         }
 147
 148         if (SDL_SetTextureBlendMode(overlay, SDL_BLENDMODE_BLEND) == -1)
 149                 WriteLog("GUI: Could not set blend mode for overlay.\n");
 150
 151         for(uint32_t i=0; i<128*380; i++)
 152                 texturePointer[i] = 0xB0A000A0;
 153
 154         SDL_UpdateTexture(overlay, NULL, texturePointer, 128 * sizeof(Uint32));
 155
 156         olDst.x = VIRTUAL_SCREEN_WIDTH;
 157         olDst.y = 2;
 158         olDst.w = 128;
 159         olDst.h = 380;
 160
 161         iconSelection  = CreateTexture(renderer, &icon_selection);
 162         diskIcon       = CreateTexture(renderer, &disk_icon);
 163         doorOpen       = CreateTexture(renderer, &door_open);
 164         doorClosed     = CreateTexture(renderer, &door_closed);
 165         disk1Icon      = CreateTexture(renderer, &disk_icon);
 166         disk2Icon      = CreateTexture(renderer, &disk_icon);
 167         powerOffIcon   = CreateTexture(renderer, &power_off);
 168         powerOnIcon    = CreateTexture(renderer, &power_on);
 169         diskSwapIcon   = CreateTexture(renderer, &disk_swap);
 170         stateSaveIcon  = CreateTexture(renderer, &save_state);
 171         stateLoadIcon  = CreateTexture(renderer, &load_state);
 172         configIcon     = CreateTexture(renderer, &config);
 173
 174         // Set up drive icons in their current states
 175 //      AssembleDriveIcon(renderer, 0);
 176 //      AssembleDriveIcon(renderer, 1);
 177
 178         if (SDL_SetRenderTarget(renderer, overlay) < 0)
 179         {
 180                 WriteLog("GUI: Could not set Render Target to overlay... (%s)\n", SDL_GetError());
 181         }
 182         else
 183         {
 184                 DrawSidebarIcons(renderer);
 185                 // Set render target back to default
 186                 SDL_SetRenderTarget(renderer, NULL);
 187         }
 188
 189         DiskSelector::Init(renderer);
 190         DiskSelector::showWindow = true;
 191
 192         WriteLog("GUI: Successfully initialized.\n");
 193 }
 194
 195
 196 SDL_Texture * GUI::CreateTexture(SDL_Renderer * renderer, const void * source)
 197 {
 198         Bitmap * bitmap = (Bitmap *)source;
 199         SDL_Texture * texture = SDL_CreateTexture(renderer, SDL_PIXELFORMAT_ABGR8888,
 200 //              SDL_TEXTUREACCESS_STATIC, bitmap->width, bitmap->height);
 201                 SDL_TEXTUREACCESS_TARGET, bitmap->width, bitmap->height);
 202         SDL_SetTextureBlendMode(texture, SDL_BLENDMODE_BLEND);
 203         SDL_UpdateTexture(texture, NULL, (Uint32 *)bitmap->pixelData,
 204                 bitmap->width * sizeof(Uint32));
 205
 206         return texture;
 207 }
 208
 209
 210 void GUI::MouseDown(int32_t x, int32_t y, uint32_t buttons)
 211 {
 212         if (sidebarState != SBS_SHOWN)
 213                 return;
 214
 215 //      char [2][2] = {};
 216
 217         switch (iconSelected)
 218         {
 219         // Power
 220         case 0:
 221                 powerOnState = !powerOnState;
 222                 SetPowerState();
 223
 224                 if (!powerOnState)
 225                         SpawnMessage("*** POWER OFF ***");
 226
 227                 break;
 228         // Disk #1
 229         case 1:
 230                 SpawnMessage("*** DISK #1 ***");
 231
 232                 if (disk1EjectHovered && !floppyDrive.IsEmpty(0))
 233                         SpawnMessage("*** EJECT DISK #1 ***");
 234
 235                 break;
 236         // Disk #2
 237         case 2:
 238                 SpawnMessage("*** DISK #2 ***");
 239
 240                 if (disk2EjectHovered && !floppyDrive.IsEmpty(1))
 241                         SpawnMessage("*** EJECT DISK #2 ***");
 242
 243                 break;
 244         // Swap disks
 245         case 3:
 246                 SpawnMessage("*** SWAP DISKS ***");
 247                 break;
 248         // Save state
 249         case 4:
 250                 SpawnMessage("*** SAVE STATE ***");
 251                 break;
 252         // Load state
 253         case 5:
 254                 SpawnMessage("*** LOAD STATE ***");
 255                 break;
 256         // Configuration
 257         case 6:
 258                 SpawnMessage("*** CONFIGURATION ***");
 259                 break;
 260         }
 261 }
 262
 263
 264 void GUI::MouseUp(int32_t x, int32_t y, uint32_t buttons)
 265 {
 266 }
 267
 268
 269 void GUI::MouseMove(int32_t x, int32_t y, uint32_t buttons)
 270 {
 271         if (sidebarState != SBS_SHOWN)
 272         {
 273                 iconSelected = -1;
 274
 275                 if (x > SIDEBAR_X_POS)
 276                 {
 277 //printf("GUI: sidebar showing (x = %i)...\n", x);
 278                         sidebarState = SBS_SHOWING;
 279                         dx = -8;
 280                 }
 281                 else
 282                 {
 283 //printf("GUI: sidebar hiding[1] (x = %i)...\n", x);
 284                         sidebarState = SBS_HIDING;
 285                         dx = 8;
 286                 }
 287         }
 288         else
 289         {
 290                 if (x < SIDEBAR_X_POS)
 291                 {
 292                         iconSelected = lastIconSelected = -1;
 293                         HandleIconSelection(sdlRenderer);
 294 //printf("GUI: sidebar hiding[2] (x = %i)...\n", x);
 295                         sidebarState = SBS_HIDING;
 296                         dx = 8;
 297                 }
 298                 // We're in the right zone, and the sidebar is shown, so let's select
 299                 // something!
 300                 else
 301                 {
 302                         if (y < 4 || y > 383)
 303                         {
 304                                 iconSelected = -1;
 305                         }
 306                         else
 307                                 iconSelected = (y - 4) / 54;
 308
 309                         // It's y+2 because the sidebar sits at (SIDEBAR_X_POS, 2)
 310                         disk1EjectHovered = ((x >= (SIDEBAR_X_POS + 24 + 29))
 311                                 && (x < (SIDEBAR_X_POS + 24 + 29 + 8))
 312                                 && (y >= (63 + 31 + 2))
 313                                 && (y < (63 + 31 + 2 + 7)) ? true : false);
 314
 315                         disk2EjectHovered = ((x >= (SIDEBAR_X_POS + 24 + 29))
 316                                 && (x < (SIDEBAR_X_POS + 24 + 29 + 8))
 317                                 && (y >= (117 + 31 + 2))
 318                                 && (y < (117 + 31 + 2 + 7)) ? true : false);
 319
 320                         if (iconSelected != lastIconSelected)
 321                         {
 322                                 HandleIconSelection(sdlRenderer);
 323                                 lastIconSelected = iconSelected;
 324                                 SpawnMessage("%s", iconHelp[iconSelected]);
 325
 326                                 // Show what's in the selected drive
 327                                 if (iconSelected >= 1 && iconSelected <= 2)
 328                                 {
 329                                         if (!floppyDrive.IsEmpty(iconSelected - 1))
 330                                                 SpawnMessage("\"%s\"", floppyDrive.ImageName(iconSelected - 1));
 331                                 }
 332                         }
 333                 }
 334         }
 335 }
 336
 337
 338 void GUI::HandleIconSelection(SDL_Renderer * renderer)
 339 {
 340         // Set up drive icons in their current states
 341         AssembleDriveIcon(renderer, 0);
 342         AssembleDriveIcon(renderer, 1);
 343
 344         // Reload the background...
 345         SDL_UpdateTexture(overlay, NULL, texturePointer, 128 * sizeof(Uint32));
 346
 347         if (SDL_SetRenderTarget(renderer, overlay) < 0)
 348         {
 349                 WriteLog("GUI: Could not set Render Target to overlay... (%s)\n", SDL_GetError());
 350                 return;
 351         }
 352
 353         // Draw the icon selector, if an icon is selected
 354         if (iconSelected >= 0)
 355         {
 356                 SDL_Rect dst;// = { 54, 54, 24 - 7, 2 };
 357                 dst.w = dst.h = 54, dst.x = 24 - 7, dst.y = 2 + (iconSelected * 54);
 358                 SDL_RenderCopy(renderer, iconSelection, NULL, &dst);
 359         }
 360
 361         DrawSidebarIcons(renderer);
 362
 363         // Set render target back to default
 364         SDL_SetRenderTarget(renderer, NULL);
 365 }
 366
 367
 368 void GUI::AssembleDriveIcon(SDL_Renderer * renderer, int driveNumber)
 369 {
 370         SDL_Texture * drive[2] = { disk1Icon, disk2Icon };
 371         const char * number[2] = { numeralOne, numeralTwo };
 372
 373         if (SDL_SetRenderTarget(renderer, drive[driveNumber]) < 0)
 374         {
 375                 WriteLog("GUI: Could not set Render Target to overlay... (%s)\n", SDL_GetError());
 376                 return;
 377         }
 378
 379         SDL_RenderClear(renderer);
 380         SDL_RenderCopy(renderer, diskIcon, NULL, NULL);
 381
 382         // Drive door @ (16, 7)
 383         SDL_Rect dst;
 384         dst.w = 8, dst.h = 10, dst.x = 16, dst.y = 7;
 385         SDL_RenderCopy(renderer, (floppyDrive.IsEmpty(driveNumber) ?
 386                 doorOpen : doorClosed), NULL, &dst);
 387
 388         // Numeral @ (30, 20)
 389         DrawCharArray(renderer, number[driveNumber], 30, 20, 7, 7, 0xD0, 0xE0, 0xF0);
 390         DrawDriveLight(renderer, driveNumber);
 391         DrawEjectButton(renderer, driveNumber);
 392
 393         // Set render target back to default
 394         SDL_SetRenderTarget(renderer, NULL);
 395 }
 396
 397
 398 void GUI::DrawEjectButton(SDL_Renderer * renderer, int driveNumber)
 399 {
 400         if (floppyDrive.IsEmpty(driveNumber))
 401                 return;
 402
 403         uint8_t r = 0x00, g = 0xAA, b = 0x00;
 404
 405         if ((driveNumber == 0 && disk1EjectHovered)
 406                 || (driveNumber == 1 && disk2EjectHovered))
 407                 r = 0x20, g = 0xFF, b = 0x20;
 408
 409 //      DrawCharArray(renderer, ejectIcon, 29, 31, 8, 7, 0x00, 0xAA, 0x00);
 410         DrawCharArray(renderer, ejectIcon, 29, 31, 8, 7, r, g, b);
 411 }
 412
 413
 414 void GUI::DrawDriveLight(SDL_Renderer * renderer, int driveNumber)
 415 {
 416         int lightState = floppyDrive.DriveLightStatus(driveNumber);
 417         int r = 0x77, g = 0x00, b = 0x00;
 418
 419         if (lightState == DLS_READ)
 420                 r = 0x20, g = 0xFF, b = 0x20;
 421         else if (lightState == DLS_WRITE)
 422                 r = 0xFF, g = 0x30, b = 0x30;
 423
 424         // Drive light @ (8, 21)
 425         DrawCharArray(renderer, driveLight, 8, 21, 5, 5, r, g, b);
 426 }
 427
 428
 429 void GUI::DrawCharArray(SDL_Renderer * renderer, const char * array, int x,
 430         int y, int w, int h, int r, int g, int b)
 431 {
 432         SDL_SetRenderDrawColor(renderer, r, g, b, 0xFF);
 433
 434         for(int j=0; j<h; j++)
 435         {
 436                 for(int i=0; i<w; i++)
 437                 {
 438                         if (array[(j * w) + i] != ' ')
 439                                 SDL_RenderDrawPoint(renderer, x + i, y + j);
 440                 }
 441         }
 442
 443         SDL_SetRenderDrawColor(renderer, 0x00, 0x00, 0x00, 0x00);
 444 }
 445
 446
 447 void GUI::HandleGUIState(void)
 448 {
 449         olDst.x += dx;
 450
 451         if (olDst.x < SIDEBAR_X_POS && sidebarState == SBS_SHOWING)
 452         {
 453                 olDst.x = SIDEBAR_X_POS;
 454                 sidebarState = SBS_SHOWN;
 455                 dx = 0;
 456         }
 457         else if (olDst.x > VIRTUAL_SCREEN_WIDTH && sidebarState == SBS_HIDING)
 458         {
 459                 olDst.x = VIRTUAL_SCREEN_WIDTH;
 460                 sidebarState = SBS_HIDDEN;
 461                 dx = 0;
 462         }
 463 }
 464
 465
 466 void GUI::DrawSidebarIcons(SDL_Renderer * renderer)
 467 {
 468         SDL_Texture * icons[7] = { powerOnIcon, disk1Icon, disk2Icon, diskSwapIcon,
 469                 stateSaveIcon, stateLoadIcon, configIcon };
 470
 471         icons[0] = (powerOnState ? powerOnIcon : powerOffIcon);
 472
 473         SDL_Rect dst;
 474         dst.w = dst.h = 40, dst.x = 24, dst.y = 2 + 7;
 475
 476         for(int i=0; i<7; i++)
 477         {
 478                 SDL_RenderCopy(renderer, icons[i], NULL, &dst);
 479                 dst.y += 54;
 480         }
 481 }
 482
 483
 484 void GUI::Render(SDL_Renderer * renderer)
 485 {
 486         if (!overlay)
 487                 return;
 488
 489         HandleGUIState();
 490
 491         if (sidebarState != SBS_HIDDEN)
 492                 HandleIconSelection(renderer);
 493
 494         SDL_RenderCopy(renderer, overlay, NULL, &olDst);
 495
 496         // Hmm.
 497         DiskSelector::Render(renderer);
 498 }
 499
 500
 501 /*
 502 GUI Considerations:
 503
 504 screen is 560 x 384
 505
 506 cut into 7 pieces give ~54 pix per piece
 507 So, let's try 40x40 icons, and see if that's good enough...
 508 Selection is 54x54.
 509
 510 drive proportions: 1.62 : 1
 511
 512 Icon order:
 513
 514 +-----+
 515 |     |
 516 |Power|
 517 |     |
 518 +-----+
 519
 520 +-----+
 521 |     |
 522 |Disk1|
 523 |    ^| <-- eject button
 524 +-----+
 525
 526 +-----+
 527 |     |
 528 |Disk2|
 529 |    ^|
 530 +-----+
 531
 532 +-----+
 533 |     |
 534 |Swap |
 535 |     |
 536 +-----+
 537
 538 +-----+
 539 |     |
 540 |Confg|
 541 |     |
 542 +-----+
 543
 544 maybe state save/load
 545
 546 */
 547