From f9bb2adaa11be25f880c323f66210a13868fa90d Mon Sep 17 00:00:00 2001 From: foswret Date: Sat, 10 Oct 2026 20:55:15 -0500 Subject: Fix mangled filesync, add descriptive comments --- src/draw.c | 210 ++++++++++++++++++++++++++++++++++--------------------------- 1 file changed, 118 insertions(+), 92 deletions(-) (limited to 'src/draw.c') diff --git a/src/draw.c b/src/draw.c index 1dffbd4..970b5fc 100644 --- a/src/draw.c +++ b/src/draw.c @@ -6,30 +6,36 @@ #include "color.h" -// struct for storing dimensions used for calculations, movement, etc. +/* struct for storing dimensions used for calculations, movement, etc. */ struct dimensions { - // Multiplication factors + /* Multiplication factors */ int row_count; /* rows */ int column_count; /* columns */ - // All of these are in units chosen by width in "calp.c" - // Most likely milimeters (mm) - double paper_width; /* paper width */ - double paper_height; /* paper height */ - double month_width; /* month width */ - double month_height; /* month height */ - double month_top_corner_x; - double month_top_corner_y; - double day_width; /* day box width */ - double day_height; /* day box height */ - double margin; /* margin */ - double header_width; - double header_height; + + /* All of these are in units chosen by width in "calp.c". They should be + * measured in milimeters (mm) */ + double paper_width; /* paper width */ + double paper_height; /* paper height */ + + double month_width; /* month width */ + double month_height; /* month height */ + + double month_x; /* Top left month x pos. */ + double month_y; /* Top left month y pos. */ + + double day_width; /* day box width */ + double day_height; /* day box height */ + + double header_width; /* header width */ + double header_height; /* header height */ + + double margin; /* paper margin */ }; -// struct to hold Month-specific info, like what day of the week the first -// day lands on, how many days are in the month, etc. +/* struct to hold Month-specific info, like what day of the week the first day + * lands on, how many days are in the month, etc. */ struct month_info { int month_position; @@ -41,7 +47,7 @@ month_info { }; -// struct for defining RGB colors +/* struct for defining RGB colors */ struct RGB { double r; @@ -50,31 +56,36 @@ RGB { }; -// Generic struct for storing where an object is and how -// it takes up space. -struct extents { +/* Generic struct for storing where an object is and how it takes up space. */ +/* TODO: Depricate dimensions struct in favor of atomic extents structs for + * each "object" (paper, month, header, etc.) */ +struct extents +{ double x; double y; double width; double height; }; -struct alignment { +/* Alignment measurments about spacing. Measured in milimeters (mm). */ +struct alignment +{ double margin; double padding; }; -// Convert Hex color strings to their RGB counterparts. -// IMO, hex strings are easier to work with, so this is -// a nice helper function. -struct -RGB hex_to_rgb(char *str) { +/* Convert Hex color strings to their RGB counterparts. Hex strings are easier + * to work with, so this is a nice helper function. returns a RGB struct value. */ + struct +RGB hex_to_rgb(char *str) +{ unsigned int r, g, b; struct RGB color; sscanf(str, "%02x%02x%02x", &r, &g, &b); - - // R, G, B values are from 0.0 - 1.0, so needs to be divided by 255.0 + + /* Red, Green, and Blue values are from 0.0 - 1.0, so needs to be divided by + * 255.0. */ color.r = (r / 255.0); color.g = (g / 255.0); color.b = (b / 255.0); @@ -84,29 +95,30 @@ RGB hex_to_rgb(char *str) { -// Set a context's color using a HEX code. Color macros are defined -// in color.h -int -set_color(cairo_t *c, char *hex) { +/* Set a context's color using a HEX code. Color macros are defined in color.h. */ + int +set_color(cairo_t *c, char *hex) +{ struct RGB color = hex_to_rgb(hex); cairo_set_source_rgb (c, color.r, color.g, color.b); return 0; } -// Get the day of the week for a given day -// Used for calculating when the start of a month is -// Relative to "Su Mo Tu ... Sa" frame, not when Su and Sa are together -// Range is 0 -> 6 -// https://wiki.c2.com/?PerpetualCalendarAlgorithm -int -day_of_week (int d, int m, int y) { +/* Get the day of the week for a given day. Used for calculating when the start + * of a month is relative to "Su Mo Tu ... Sa" frame, not when Su and Sa are + * together. Range is 0 -> 6. + * + * https://wiki.c2.com/?PerpetualCalendarAlgorithm */ + int +day_of_week (int d, int m, int y) +{ return((d += m < 3 ? y-- : y - 2, 23*m/9 + d + 4 + y/4- y/100 + y/400)%7); } -// Fill entire background with current color -// Function name is changed for clarity +/* Fill entire background with current color. Function name is changed for + * clarity. */ int fill_bg(cairo_t *c) { cairo_paint(c); @@ -116,23 +128,25 @@ fill_bg(cairo_t *c) { -// Needn't be a string pointer, can be fixed array of chars -// Requires Font Family (string) and Size (int) -// Creates and destroys layout within the scope of the function -// Is that performant when looped over 365 operations? +/* Draw a string of text on the screen with specific font size, position, and + * font family. Needn't be a string pointer, can be fixed array of chars. + * Creates and destroys layout within the scope of the function + * TODO: Is this performant when looped over 365 operations? */ int -draw_text (cairo_t *c, double x, double y, char *font_family, int font_size, char *text) { +draw_text (cairo_t *c, double x, double y, + char *font_family, int font_size, char *text) { + char font[100]; - // Concat font string for pango_font_description_from_string + /* Concat font string for pango_font_description_from_string */ snprintf(font, sizeof(font), "%s %d", font_family, font_size); - //Initialize Pango Stuff + /* Initialize Pango Stuff */ PangoLayout *layout; PangoFontDescription *desc; - // Create a PangoLayout, setting font & text + /* Create a PangoLayout, setting font & text */ layout = pango_cairo_create_layout(c); desc = pango_font_description_from_string(font); pango_layout_set_font_description(layout, desc); @@ -148,20 +162,19 @@ draw_text (cairo_t *c, double x, double y, char *font_family, int font_size, cha } -// Get the dimensions of a string of text -// Returns a PangoRectangle struct +/* Get the dimensions of a string of text. Returns a PangoRectangle struct. */ PangoRectangle get_logical_extents (cairo_t *c, char *font_family, int font_size, char *text) { char font[100]; - // Concat font string for pango_font_description_from_string + /* Concat font string for pango_font_description_from_string */ snprintf(font, sizeof(font), "%s %d", font_family, font_size); PangoLayout *layout; PangoFontDescription *desc; PangoRectangle rect; - // Create a PangoLayout, setting font & text + /* Create a PangoLayout, setting font & text */ layout = pango_cairo_create_layout(c); desc = pango_font_description_from_string(font); pango_layout_set_font_description(layout, desc); @@ -175,19 +188,20 @@ get_logical_extents (cairo_t *c, char *font_family, int font_size, char *text) { return(rect); } - +/* Get the VISUAL dimensions of a string of text. Returns a PangoRectangle + * struct. */ PangoRectangle get_ink_extents (cairo_t *c, char *font_family, int font_size, char *text) { char font[100]; - // Concat font string for pango_font_description_from_string + /* Concat font string for pango_font_description_from_string */ snprintf(font, sizeof(font), "%s %d", font_family, font_size); PangoLayout *layout; PangoFontDescription *desc; PangoRectangle rect; - // Create a PangoLayout, setting font & text + /* Create a PangoLayout, setting font & text */ layout = pango_cairo_create_layout(c); desc = pango_font_description_from_string(font); pango_layout_set_font_description(layout, desc); @@ -201,36 +215,36 @@ get_ink_extents (cairo_t *c, char *font_family, int font_size, char *text) { return(rect); } -// Calculate dimenions for one page and stores it in the dimensions struct -// Used for determining where elements should be drawn on the page +/* Calculate dimenions for one page and store it in the dimensions struct. Used + * for determining where elements should be drawn on the page. */ int calculate_dimensions(double pw, double ph, struct dimensions *d) { d->row_count = 6; d->column_count = 7; - // Percentage of page that should be margin + /* Percentage of page that should be margin */ double margin = 0.05 * pw; - - // width of day is 1/7th of total width + + /* width of day is 1/7th of total width */ double box_width = pw / 10.0; - // Everything other than margin + /* Everything other than margin */ double month_width = box_width * d->column_count; - // Width = Height; Day Box is a square + /* Width = Height; Day Box is a square */ double box_height = box_width; - // Height is based on how tall # of weeks are + /* Height is based on how tall # of weeks are */ double month_height = box_height * d->row_count; - // Set items in struct to calculated values + /* Set items in struct to calculated values */ d->paper_width = pw; d->paper_height = ph; d->margin = margin; d->month_width = month_width; - d->month_top_corner_x = (pw - (month_width)) / 2.0; - d->month_top_corner_y = ph - margin - month_height; + d->month_x = (pw - (month_width)) / 2.0; + d->month_y = ph - margin - month_height; d->month_height = month_height; d->day_width = box_width; d->day_height = box_height; @@ -245,7 +259,7 @@ calculate_dimensions(double pw, double ph, struct dimensions *d) { int calculate_minimum_rows(struct month_info *m) { int extra_rows = 0; - + int days_in_first_week = (7 - m->first_day); if (m->first_day == 0) { @@ -271,7 +285,7 @@ calculate_minimum_rows(struct month_info *m) { -// Draws the grid lines for a month +/* Draws the grid lines for a month */ int draw_month_grid (cairo_t *c, struct month_info *m, struct extents *me, struct extents *de) { double cursor_x = me->x; @@ -288,18 +302,18 @@ draw_month_grid (cairo_t *c, struct month_info *m, struct extents *me, struct ex set_color(c, BLACK); cairo_set_line_width(c, 1.0); - // Vertical lines + /* Vertical lines */ for (int i = 0; i <= m->column_count; i++) { cairo_move_to(c, cursor_x, cursor_y); cairo_line_to(c, cursor_x, cursor_y + (me->height - (row_offset * de->height))); cursor_x = cursor_x + de->width; } - // Recenter the cursor + /* Recenter the cursor to the top left */ cursor_x = x; cursor_y = y; - // Horizontal lines + /* Horizontal lines */ for (int i = 0; i <= m->row_count; i++) { cairo_move_to(c, cursor_x, cursor_y); cairo_line_to(c, cursor_x + me->width, cursor_y); @@ -322,9 +336,9 @@ construct_day_box(cairo_t *cd, int month, int day, int week_day) { if ((month == 0) && (day == 1) && (week_day == 1)) { } - - // draw_text(), and therefore pango_layout_set_text(), needs a - // string as input, so the current day's date is converted. + + /* draw_text(), and therefore pango_layout_set_text(), needs a string as + * input, so the current day's date is converted. */ snprintf(str, sizeof(str), "%d", day); set_color(cd, BLACK); @@ -334,14 +348,17 @@ construct_day_box(cairo_t *cd, int month, int day, int week_day) { -// Draws one month using daybox sub-surface & context, main context, and dimension struct +/* Draws one month using daybox sub-surface & context, main context, and + * dimension struct. */ int -draw_month_dates(cairo_t *c, cairo_t *cd, cairo_surface_t *s, struct month_info *m, struct extents *me, struct extents *de) { +draw_month_dates(cairo_t *c, cairo_t *cd, cairo_surface_t *s, + struct month_info *m, struct extents *me, struct extents *de) { + double cursor_x = me->x; if (m->first_day != 0) cursor_x = cursor_x + (de->width * m->first_day); - // Push bottom of month as far down the page as the margin allows + /* Push bottom of month as far down the page as the margin allows. */ int row_offset = m->row_count - calculate_minimum_rows(m); double cursor_y = me->y + (row_offset * de->height); @@ -352,27 +369,26 @@ draw_month_dates(cairo_t *c, cairo_t *cd, cairo_surface_t *s, struct month_info for (int i = 0; i < m->row_count; i++) { for (int k = current_day; k < m->column_count; k++) { - // When the increment reached the end of the month, end - // the function. + /* When the increment reached the end of the month, end the function. */ if (increment >= m->num_of_days) return 0; construct_day_box(cd, m->month_position, increment + 1, k); - // Position the constructed day box on main surface + /* Position the constructed day box on main surface */ cairo_set_source_surface (c, s, cursor_x, cursor_y); cairo_paint(c); - // Move cursor one "box" over + /* Move cursor one "box" over */ cursor_x = cursor_x + de->width; increment++; } current_day = 0; - - cursor_x = me->x; - cursor_y = cursor_y + de->height; + + cursor_x = me->x; + cursor_y = cursor_y + de->height; } cairo_stroke(cd); @@ -381,9 +397,10 @@ draw_month_dates(cairo_t *c, cairo_t *cd, cairo_surface_t *s, struct month_info -// Draws the month being drawn at the top of the page +/* Draws the month name at the top of the month image */ int -draw_month_title(cairo_t *c, struct extents *he, struct alignment *pl, char *font_family, int font_size, char *name) { +draw_month_title(cairo_t *c, struct extents *he, struct alignment *pl, + char *font_family, int font_size, char *name) { PangoRectangle rect; @@ -396,7 +413,16 @@ draw_month_title(cairo_t *c, struct extents *he, struct alignment *pl, char *fon return 0; } -//int -//draw_week_names(cairo_t *c, struct month_info *m, struct extents *me, struct extents *dte, char **names) { -// return 0; -//} +/* Draw the shorthand names for the days of the week on top of the month */ +int +draw_week_names(cairo_t *c, struct extents *me) { + char *names[] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"}; + + char *font_family = "Sans"; + int font_size = 10; + + for (int i = 0; i < 7; i++) { + draw_text(c, me->x, me->y, font_family, font_size, names[i]); + } + return 0; +} -- cgit v1.2.3