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