X-Git-Url: http://git.subgeniuskitty.com/screensavers/.git/blobdiff_plain/a98a69c16192dcdc1ebf73cea2fea3610d3c4f36..2c7168aee9615d18be64807d9524ea47ac0bfaf4:/hacks/NEDsim/NEDsim.c diff --git a/hacks/NEDsim/NEDsim.c b/hacks/NEDsim/NEDsim.c index df95105..71e4b99 100644 --- a/hacks/NEDsim/NEDsim.c +++ b/hacks/NEDsim/NEDsim.c @@ -1,114 +1,124 @@ /* (c) 2021 Aaron Taylor */ /* See LICENSE.txt file for copyright and license details. */ -// TODO: -// - Write a brief description of the machine being simulated. Only one thread, reduced RAM, no meaningful console when running as screensaver, etc. - -// CLI Flags: -// -path-to-aout-binary -// -path-to-font-file -// -speed - -// Ideas for sample programs to include: -// - Build list of integers on the stack (DUP, IM_1, ADD). -// - Calculate prime numbers, placing them on the stack. -// - Lights sliding back and forth, like PDP-11 front panel with some OSes. - #include "screenhack.h" #include "simulator.h" -/* Keep this source code C89 compliant per XScreensaver's instructions. */ - /* -------------------------------------------------------------------------- */ /* Data Structures */ /* -------------------------------------------------------------------------- */ struct NEDsim { - /* Various X resources */ + // Various X resources Display * dpy; Window win; GC gc; - // TODO: Explain these + // Tracks the width and height (in pixels) of 'win' on 'dpy'. int dpy_width, dpy_height; - // TODO: Explain that this is created during init, then lights are populated/overwritten on each frame. + // To ensure the NED display is always synchronized/valid, we + // double-buffer. This is that buffer. Pixmap panel; - /* Delay (in microseconds) between clock cycles in the NED CPU. */ - size_t delay; - + // The front panel is defined in a fixed grid of 'cells' which are then + // scaled and projected onto the actual screen. This variable tracks the + // size of one 'cell' in screen pixels. int cell_size; + // Like above, this variable tracks the scaled size (in pixels) of cell + // borders when projecting them on the screen. int border_size; + + // Since the panel will be smaller than the display window, these two + // variable track the location (in pixels) of the upper left corner of the + // NED panel (pretending it didn't have rounded corners) relative to the + // display window's origin. int origin_x_offset, origin_y_offset; + + // Delay (in microseconds) between clock cycles in the NED CPU. + size_t delay; + + // Since the heap and stack areas are resized to fit the display, this + // variable tracks their height. int num_data_rows; + // This is an index into the color_list[] array, selecting a color scheme. size_t color_index; + // If the display is unsuitable (e.g. too small), this boolean is 'true'. + // With this, we blank the display but keep the simulation itself running, + // allowing the ongoing simulation to display when the situation is + // corrected, and allowing us to avoid boring the user with unnecessary + // simulation restarts. Bool suitable_display; + // The font size is dynamically adjusted based on display size. This + // variable stores the full font description, including the correct font + // size, all in the X11 font specifier format. For example, + // -*-helvetica-*-r-*-*-72-*-*-*-*-*-*-* + // if the display were using a 72 point helvetica font without emphasis. char * current_font; - // TODO: Explain that this contains all the actual state of the NED machine being simulated. + // This struct contains all machine state for the simulated NED computer. struct NEDstate * nedstate; }; struct color_rgb { - // TODO: Explain why this is an unsigned short. Copy from WolframAutomata. + // The type 'unsigned short' comes from the XColor struct definition. + // The red, green, and blue values are always in the range 0 to 65535 + // inclusive, independent of the number of bits actually used in the + // display hardware. The server scales these values to the range used + // by the hardware. Black is represented by (0,0,0), and white is + // represented by (65535,65535,65535). unsigned short red, green, blue; }; struct color_scheme { - // TODO: Explain all this. + // The following entries define a full color scheme for a NED panel. struct color_rgb - panel_bg, - panel_fg, - light_on, - light_off, - error_on, - error_off, - primary, - secondary, - tertiary, - border, - text; + panel_bg, // Empty screen space not taken up by the panel + panel_fg, // Panel body/faceplate + light_on, // Illuminated data indicator + light_off, // Non-illuminated data indicator + error_on, // Illuminated error indicator + error_off, // Non-illuminated error indicator + primary, // Primary panel color (see: logo background) + secondary, // Secondary panel color (see: "HALT" text background) + tertiary, // Tertiary panel color (see: "subgeniuskitty.com" text background) + border, // Cell borders + text; // Panel text }; -//static struct color_scheme color_list[] = { -// // TODO: Explain all this. -// // TODO: Add other color schemes, like purple PDP-11/70. -// // TODO: http://www.chdickman.com/pdp8/DECcolors/ -// { -// {63479,63479,63479}, // 092-XXXX-123 -// { 5140, 2056, 5654}, // 092-XXXX-152 -// {40092,11051,15677}, // 092-XXXX-139 -// {30326,13107,12850}, // 092-XXXX-154 -// {65535,13107,12850}, // homemade -// {30326,13107,12850}, // 092-XXXX-154 -// { 4112,12850,20046}, // 092-XXXX-145 -// {12336,29555,37008}, // 092-XXXX-151 -// {30326,24158, 6425}, // 092-XXXX-157 -// {63479,63479,63479}, // 092-XXXX-123 -// {63479,63479,63479} // 092-XXXX-123 -// } -//}; - +// All included color schemes for NEDsim are defined in this array. To select a +// particular color scheme at runtime, use the `-color N` CLI option. static struct color_scheme color_list[] = { - // TODO: Explain all this. - // TODO: Add other color schemes, like purple PDP-11/70. - // TODO: http://www.chdickman.com/pdp8/DECcolors/ - { + { // This color scheme is inspired by the KI10 version of the PDP-10. + // Many RGB values came from: http://www.chdickman.com/pdp8/DECcolors/ {63479,63479,63479}, // 092-XXXX-123 { 5140, 2056, 5654}, // 092-XXXX-152 - {65535,11051,15677}, // 092-XXXX-139 - edit - {20000,13107,12850}, // 092-XXXX-154 - edit - {65535,13107,12850}, // homemade - {20000,13107,12850}, // 092-XXXX-154 - edit + {65535,11051,15677}, // homemade, derived from 092-XXXX-139 + {20000,13107,12850}, // homemade, derived from 092-XXXX-154 + {65535,13107,12850}, // homemade, derived from 092-XXXX-154 + {20000,13107,12850}, // homemade, derived from 092-XXXX-154 { 4112,12850,20046}, // 092-XXXX-145 {12336,29555,37008}, // 092-XXXX-151 {30326,24158, 6425}, // 092-XXXX-157 {63479,63479,63479}, // 092-XXXX-123 {63479,63479,63479} // 092-XXXX-123 + }, + { // This color scheme is (very loosely) inspired by the first version of the PDP-11/70. + // Many RGB values came from: http://www.chdickman.com/pdp8/DECcolors/ + {63479,63479,63479}, // 092-XXXX-123 + { 5140, 2056, 5654}, // 092-XXXX-152 + {51400,34952,26682}, // homemade, derived from 092-XXXX-136 + {20000,13107,12850}, // homemade, derived from 092-XXXX-154 + {65535,13107,12850}, // homemade, derived from 092-XXXX-154 + {20000,13107,12850}, // homemade, derived from 092-XXXX-154 + {28270, 8995,19532}, // 092-XXXX-140 + {40092,11051,15677}, // 092-XXXX-139 + {15000,21000, 4000}, // homemade, derived from 092-XXXX-129 + {63479,63479,63479}, // 092-XXXX-123 + {63479,63479,63479} // 092-XXXX-123 } }; @@ -215,20 +225,20 @@ draw_rect_area(struct NEDsim * nedsim, size_t x_origin, size_t y_origin, size_t y_origin += nedsim->origin_y_offset; x_size *= nedsim->cell_size; y_size *= nedsim->cell_size; - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, x_origin, y_origin, x_size, y_size); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, x_origin, y_origin, x_size, y_size); set_color(nedsim, &color_list[nedsim->color_index].border); if (bord_top) { - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, x_origin, y_origin, x_size, nedsim->border_size); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, x_origin, y_origin, x_size, nedsim->border_size); } if (bord_bottom) { - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, x_origin, (y_origin + y_size - nedsim->border_size), x_size, nedsim->border_size); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, x_origin, (y_origin + y_size - nedsim->border_size), x_size, nedsim->border_size); } if (bord_left) { - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, x_origin, y_origin, nedsim->border_size, y_size); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, x_origin, y_origin, nedsim->border_size, y_size); } if (bord_right) { - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, (x_origin + x_size - nedsim->border_size), y_origin, nedsim->border_size, y_size); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, (x_origin + x_size - nedsim->border_size), y_origin, nedsim->border_size, y_size); } } @@ -260,7 +270,7 @@ draw_circular_area(struct NEDsim * nedsim, size_t x, size_t y, double diameter) y -= (0.5 * nedsim->border_size); // Start angle 0 and ending angle 360*64 is one full circle in Xlib units. - XFillArc(nedsim->dpy, nedsim->win, nedsim->gc, x, y, diameter, diameter, 0, 360*64); + XFillArc(nedsim->dpy, nedsim->panel, nedsim->gc, x, y, diameter, diameter, 0, 360*64); } // TODO: Explain @@ -274,11 +284,11 @@ draw_panel(struct NEDsim * nedsim) // Draw background color over entire window. set_color(nedsim, &color_list[nedsim->color_index].panel_bg); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, 0, 0, nedsim->dpy_width, nedsim->dpy_height); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, 0, 0, nedsim->dpy_width, nedsim->dpy_height); // Draw NED panel in foreground color. set_color(nedsim, &color_list[nedsim->color_index].panel_fg); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset, nedsim->origin_y_offset, nedsim->cell_size * OVERALL_WIDTH_IN_CELLS, @@ -287,25 +297,25 @@ draw_panel(struct NEDsim * nedsim) // Give the panel rounded corners by first deleting the four right-angle corners... set_color(nedsim, &color_list[nedsim->color_index].panel_bg); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset, nedsim->origin_y_offset, nedsim->cell_size, nedsim->cell_size ); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset + (nedsim->cell_size * (OVERALL_WIDTH_IN_CELLS-1)), nedsim->origin_y_offset, nedsim->cell_size, nedsim->cell_size ); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset, nedsim->origin_y_offset + (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + nedsim->num_data_rows + FOOTER_HEIGHT_IN_CELLS - 1)), nedsim->cell_size, nedsim->cell_size ); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset + (nedsim->cell_size * (OVERALL_WIDTH_IN_CELLS-1)), nedsim->origin_y_offset + (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + nedsim->num_data_rows + FOOTER_HEIGHT_IN_CELLS - 1)), nedsim->cell_size, @@ -313,25 +323,25 @@ draw_panel(struct NEDsim * nedsim) ); // ...and then replacing them with filled arcs, forming rounded corners. set_color(nedsim, &color_list[nedsim->color_index].panel_fg); - XFillArc(nedsim->dpy, nedsim->win, nedsim->gc, + XFillArc(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset, nedsim->origin_y_offset, nedsim->cell_size * 2, nedsim->cell_size * 2, 180*64, -90*64 ); - XFillArc(nedsim->dpy, nedsim->win, nedsim->gc, + XFillArc(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset + (nedsim->cell_size * (OVERALL_WIDTH_IN_CELLS-2)), nedsim->origin_y_offset, nedsim->cell_size * 2, nedsim->cell_size * 2, 0, 90*64 ); - XFillArc(nedsim->dpy, nedsim->win, nedsim->gc, + XFillArc(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset, nedsim->origin_y_offset + (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + nedsim->num_data_rows + FOOTER_HEIGHT_IN_CELLS - 2)), nedsim->cell_size * 2, nedsim->cell_size * 2, 180*64, 90*64 ); - XFillArc(nedsim->dpy, nedsim->win, nedsim->gc, + XFillArc(nedsim->dpy, nedsim->panel, nedsim->gc, nedsim->origin_x_offset + (nedsim->cell_size * (OVERALL_WIDTH_IN_CELLS-2)), nedsim->origin_y_offset + (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + nedsim->num_data_rows + FOOTER_HEIGHT_IN_CELLS - 2)), nedsim->cell_size * 2, nedsim->cell_size * 2, @@ -362,7 +372,7 @@ draw_logo(struct NEDsim * nedsim) get_text_size(nedsim, "NED", &text_x_size, &text_y_size); int local_x_offset = ((LOGO_WIDTH * nedsim->cell_size) - text_x_size) / 2; int local_y_offset = ((LOGO_NAME_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (LOGO_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (LOGO_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((LOGO_Y_OFFSET+LOGO_NAME_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "NED", 3); // And draw the 'subgeniuskitty.com' text in the bottom box. @@ -370,7 +380,7 @@ draw_logo(struct NEDsim * nedsim) get_text_size(nedsim, "subgeniuskitty.com", &text_x_size, &text_y_size); local_x_offset = ((LOGO_WIDTH * nedsim->cell_size) - text_x_size) / 2; local_y_offset = ((LOGO_WEBSITE_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (LOGO_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (LOGO_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((LOGO_Y_OFFSET+LOGO_NAME_HEIGHT+LOGO_WEBSITE_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "subgeniuskitty.com", 18); } @@ -396,7 +406,7 @@ draw_halt(struct NEDsim * nedsim) get_text_size(nedsim, "HALT", &text_x_size, &text_y_size); int local_x_offset = ((HALT_WIDTH * nedsim->cell_size) - text_x_size) / 2; int local_y_offset = ((HALT_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (HALT_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (HALT_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((HALT_Y_OFFSET+HALT_LIGHT_HEIGHT+HALT_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "HALT", 4); } @@ -460,7 +470,7 @@ draw_pc(struct NEDsim * nedsim) get_text_size(nedsim, "PC", &text_x_size, &text_y_size); int local_x_offset = ((PC_WIDTH * nedsim->cell_size) - text_x_size) / 2; int local_y_offset = ((PC_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (PC_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (PC_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((PC_Y_OFFSET+PC_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "PC", 2); } @@ -486,7 +496,7 @@ draw_sc(struct NEDsim * nedsim) get_text_size(nedsim, "SC", &text_x_size, &text_y_size); int local_x_offset = ((SC_WIDTH * nedsim->cell_size) - text_x_size) / 2; int local_y_offset = ((SC_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (SC_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (SC_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((SC_Y_OFFSET+SC_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "SC", 2); } @@ -518,7 +528,7 @@ draw_psw(struct NEDsim * nedsim) get_text_size(nedsim, "N", &text_x_size, &text_y_size); int local_x_offset = ((PSW_LABEL_WIDTH * nedsim->cell_size) - text_x_size) / 2; int local_y_offset = ((PSW_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (PSW_N_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (PSW_N_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((PSW_Y_OFFSET+PSW_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "N", 1); // Now draw the label text "Z". @@ -526,7 +536,7 @@ draw_psw(struct NEDsim * nedsim) get_text_size(nedsim, "Z", &text_x_size, &text_y_size); local_x_offset = ((PSW_LABEL_WIDTH * nedsim->cell_size) - text_x_size) / 2; local_y_offset = ((PSW_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, (PSW_Z_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, (PSW_Z_X_OFFSET * nedsim->cell_size + nedsim->origin_x_offset + local_x_offset), ((PSW_Y_OFFSET+PSW_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "Z", 1); } @@ -552,7 +562,7 @@ draw_stack(struct NEDsim * nedsim) int text_x_size, text_y_size; get_text_size(nedsim, "Stack Size:", &text_x_size, &text_y_size); int local_y_offset = ((STACK_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, ((STACK_X_OFFSET + 1) * nedsim->cell_size + nedsim->origin_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, ((STACK_X_OFFSET + 1) * nedsim->cell_size + nedsim->origin_x_offset), ((STACK_Y_OFFSET+STACK_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "Stack Size:", 11); } @@ -580,7 +590,7 @@ draw_heap(struct NEDsim * nedsim) int text_x_size, text_y_size; get_text_size(nedsim, "RAM Base:", &text_x_size, &text_y_size); int local_y_offset = ((HEAP_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, ((HEAP_X_OFFSET + 1) * nedsim->cell_size + nedsim->origin_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, ((HEAP_X_OFFSET + 1) * nedsim->cell_size + nedsim->origin_x_offset), ((HEAP_Y_OFFSET+HEAP_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), "RAM Base:", 9); // Now draw the address text. @@ -589,7 +599,7 @@ draw_heap(struct NEDsim * nedsim) snprintf(address, sizeof(address), "0x%08X", HEAP_START_ADDRESS); get_text_size(nedsim, address, &text_x_size, &text_y_size); local_y_offset = ((HEAP_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, ((HEAP_X_OFFSET + 1 + (HEAP_WIDTH / 2)) * nedsim->cell_size + nedsim->origin_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, ((HEAP_X_OFFSET + 1 + (HEAP_WIDTH / 2)) * nedsim->cell_size + nedsim->origin_x_offset), ((HEAP_Y_OFFSET+HEAP_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), address, strlen(address)); } @@ -655,7 +665,7 @@ update_display(struct NEDsim * nedsim) int text_x_size, text_y_size; get_text_size(nedsim, stack_size, &text_x_size, &text_y_size); int local_y_offset = ((STACK_LABEL_HEIGHT * nedsim->cell_size) - text_y_size) / 2; - XDrawString(nedsim->dpy, nedsim->win, nedsim->gc, ((STACK_X_OFFSET + 1 + (STACK_WIDTH / 2)) * nedsim->cell_size + nedsim->origin_x_offset), + XDrawString(nedsim->dpy, nedsim->panel, nedsim->gc, ((STACK_X_OFFSET + 1 + (STACK_WIDTH / 2)) * nedsim->cell_size + nedsim->origin_x_offset), ((STACK_Y_OFFSET+STACK_LABEL_HEIGHT) * nedsim->cell_size + nedsim->origin_y_offset - local_y_offset), stack_size, strlen(stack_size)); // Draw the heap lights. @@ -677,18 +687,29 @@ NEDsim_event(Display * dpy, Window win, void * closure, XEvent * event) static void NEDsim_free(Display * dpy, Window win, void * closure) { - // TODO: Replace all this with proper code to free everything. struct NEDsim * nedsim = closure; + + if (nedsim->nedstate != NULL) { + free(nedsim->nedstate->active_thread->psw); + free(nedsim->nedstate->active_thread); + free(nedsim->nedstate->hack); + free(nedsim->nedstate); + } + + // TODO: Replace all this with proper code to free everything related to the screensaver itself. XFreeGC(nedsim->dpy, nedsim->gc); + XFreePixmap(nedsim->dpy, nedsim->panel); free(nedsim); } static void * NEDsim_init(Display * dpy, Window win) { + // ========================================================================= + // Basic Setup + // ========================================================================= + struct NEDsim * nedsim; - XGCValues gcv; - XWindowAttributes xgwa; nedsim = calloc(1, sizeof(*nedsim)); if (!nedsim) { @@ -699,50 +720,86 @@ NEDsim_init(Display * dpy, Window win) nedsim->dpy = dpy; nedsim->win = win; + XGCValues gcv; + nedsim->gc = XCreateGC(nedsim->dpy, nedsim->win, GCForeground, &gcv); + + XWindowAttributes xgwa; XGetWindowAttributes(nedsim->dpy, nedsim->win, &xgwa); nedsim->dpy_width = xgwa.width; nedsim->dpy_height = xgwa.height; - // TODO: Explain that this is the delay between each clock cycle of the simulated NED CPU. + nedsim->panel = XCreatePixmap(nedsim->dpy, nedsim->win, nedsim->dpy_width, nedsim->dpy_height, xgwa.depth); + + // ========================================================================= + // Process User Requests + // ========================================================================= + nedsim->delay = get_integer_resource(nedsim->dpy, "delay", "Integer"); nedsim->delay *= 1000; /* Turn milliseconds into microseconds. */ - // TODO: Read in the a.out file. This should be done in the simulator's init function call? - nedsim->nedstate = init_simulator(); - - nedsim->gc = XCreateGC(nedsim->dpy, nedsim->win, GCForeground, &gcv); + // If the user did not supply a program for execution, randomly select one + // of the included programs. + char * input_file = get_string_resource(nedsim->dpy, "binary", "String"); + if (input_file == NULL) { + // TODO: Need to include some default programs and randomly select one to load into RAM. + nedsim->nedstate = init_simulator("./test.out"); + } else { + nedsim->nedstate = init_simulator(input_file); + } - // TODO: Do this properly. - nedsim->color_index = 0; + // If the user did not select a color scheme, select one randomly. + nedsim->color_index = get_integer_resource(nedsim->dpy, "color", "Integer"); + if (nedsim->color_index == -1) { + nedsim->color_index = random() % sizeof(color_list)/sizeof(color_list[0]); + } else if (nedsim->color_index >= sizeof(color_list)/sizeof(color_list[0])) { + fprintf(stderr, "WARNING: Color index out of range.\n"); + nedsim->color_index = 0; + } -// TODO: Save the GIMP reference diagram somewhere, along with notes about the size/spacing, and that each cell is 10 pixels across in the reference image. + // ========================================================================= + // Scale Panel To Screen + // ========================================================================= - nedsim->cell_size = nedsim->dpy_width / OVERALL_WIDTH_IN_CELLS ; // make panel as wide as it can be while keeping every cell an integer pixel size. - // TODO: What is my minimum cell_size? Below that, I should simply paint the window red and print an error in the console. Perform that check here, right after setting cell_size. - // For now, we'll just make it 10 pixels? + // We desire to make the panel as wide as possible while also making the + // cell size an integer pixel size. + nedsim->cell_size = nedsim->dpy_width / OVERALL_WIDTH_IN_CELLS; + // Cell sizes below about 10 pixels result in unreadable fonts. For now, + // we'll use that as our cutoff. It also works well with a 1:10 border:cell + // ratio. if (nedsim->cell_size < 10) { nedsim->suitable_display = False; return nedsim; } - nedsim->origin_x_offset = (nedsim->dpy_width - (nedsim->cell_size * OVERALL_WIDTH_IN_CELLS)) / 2; // center panel horizontally - - // Determine how many rows for the stack and heap displays. Make it the largest power of two that fits on the display. - int available_space_for_data_rows = nedsim->dpy_height - (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + FOOTER_HEIGHT_IN_CELLS)); + // Center the panel horizontally. + nedsim->origin_x_offset = (nedsim->dpy_width - + (nedsim->cell_size * OVERALL_WIDTH_IN_CELLS)) / 2; + + // The stack and heap displays are variable height. Size them to fit the + // display window. + int available_space_for_data_rows = nedsim->dpy_height - + (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + FOOTER_HEIGHT_IN_CELLS)); for (int i = 0; ; i++) { if ((nedsim->cell_size * (1 << i)) > available_space_for_data_rows) { nedsim->num_data_rows = (1 << --i); break; } } + // Enforce a minimum vertical size, though '4' is arbitrary. if (nedsim->num_data_rows < 4) { nedsim->suitable_display = False; return nedsim; } - nedsim->origin_y_offset = (nedsim->dpy_height - (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + nedsim->num_data_rows + FOOTER_HEIGHT_IN_CELLS))) / 2; // center panel vertically + // Center the panel vertically. + nedsim->origin_y_offset = (nedsim->dpy_height - + (nedsim->cell_size * (HEADER_HEIGHT_IN_CELLS + nedsim->num_data_rows + FOOTER_HEIGHT_IN_CELLS))) / 2; // Scale border relative to cell_size in a 1:10 relationship. nedsim->border_size = nedsim->cell_size / 10; + // ========================================================================= + // Draw Initial Panel + // ========================================================================= + draw_panel(nedsim); draw_logo(nedsim); draw_halt(nedsim); @@ -762,14 +819,18 @@ NEDsim_draw(Display * dpy, Window win, void * closure) { struct NEDsim * nedsim = closure; + // Update the panel display buffer. if (nedsim->suitable_display) { nedsim->nedstate = run_simulator(nedsim->nedstate); update_display(nedsim); } else { set_color(nedsim, &color_list[nedsim->color_index].error_on); - XFillRectangle(nedsim->dpy, nedsim->win, nedsim->gc, 0, 0, nedsim->dpy_width, nedsim->dpy_height); + XFillRectangle(nedsim->dpy, nedsim->panel, nedsim->gc, 0, 0, nedsim->dpy_width, nedsim->dpy_height); } + // Copy panel buffer to display window. + XCopyArea(nedsim->dpy, nedsim->panel, nedsim->win, nedsim->gc, 0, 0, nedsim->dpy_width, nedsim->dpy_height, 0, 0); + return nedsim->delay; } @@ -777,22 +838,32 @@ static void NEDsim_reshape(Display * dpy, Window win, void * closure, unsigned int w, unsigned int h) { struct NEDsim * nedsim = closure; + + // Only re-initialize the display if it changed size. XWindowAttributes xgwa; XGetWindowAttributes(nedsim->dpy, nedsim->win, &xgwa); - /* Only restart the simulation if the window changed size. */ if (nedsim->dpy_width != xgwa.width || nedsim->dpy_height != xgwa.height) { - NEDsim_free(dpy, win, closure); - closure = NEDsim_init(dpy, win); + // Although we are re-initializing the display, we wish to retain the + // in-progress NED simulation. Thus, we retain the NEDstate pointer. + struct NEDstate * original_nedstate = nedsim->nedstate; + nedsim->nedstate = NULL; + NEDsim_free(dpy, win, nedsim); + struct NEDsim * new_nedsim = NEDsim_init(dpy, win); + new_nedsim->nedstate = original_nedstate; + closure = new_nedsim; } } static const char * NEDsim_defaults[] = { "*delay: 250", + "*color: -1", 0 }; static XrmOptionDescRec NEDsim_options[] = { { "-delay", ".delay", XrmoptionSepArg, 0 }, + { "-binary", ".binary", XrmoptionSepArg, 0 }, + { "-color", ".color", XrmoptionSepArg, 0 }, { 0, 0, 0, 0 } };