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