// Copyright 2012-2023 David Robillard // SPDX-License-Identifier: ISC // Common implementations of public API functions in the core library #include "internal.h" #include "platform.h" #include "types.h" #include "pugl/pugl.h" #include #include #include #include #include const char* puglStrerror(const PuglStatus status) { // clang-format off switch (status) { case PUGL_SUCCESS: return "Success"; case PUGL_FAILURE: return "Non-fatal failure"; case PUGL_UNKNOWN_ERROR: return "Unknown system error"; case PUGL_BAD_BACKEND: return "Invalid or missing backend"; case PUGL_BAD_CONFIGURATION: return "Invalid view configuration"; case PUGL_BAD_PARAMETER: return "Invalid parameter"; case PUGL_BACKEND_FAILED: return "Backend initialisation failed"; case PUGL_REGISTRATION_FAILED: return "Class registration failed"; case PUGL_REALIZE_FAILED: return "View creation failed"; case PUGL_SET_FORMAT_FAILED: return "Failed to set pixel format"; case PUGL_CREATE_CONTEXT_FAILED: return "Failed to create drawing context"; case PUGL_UNSUPPORTED: return "Unsupported operation"; case PUGL_NO_MEMORY: return "Failed to allocate memory"; } // clang-format on return "Unknown error"; } PuglWorld* puglNewWorld(PuglWorldType type, PuglWorldFlags flags) { PuglWorld* world = (PuglWorld*)calloc(1, sizeof(PuglWorld)); if (!world || !(world->impl = puglInitWorldInternals(type, flags))) { free(world); return NULL; } world->startTime = puglGetTime(world); world->type = type; puglSetString(&world->strings[PUGL_CLASS_NAME], "Pugl"); return world; } void puglFreeWorld(PuglWorld* const world) { puglFreeWorldInternals(world); for (size_t i = 0; i < PUGL_NUM_STRING_HINTS; ++i) { free(world->strings[i]); } free(world->views); free(world); } void puglSetWorldHandle(PuglWorld* world, PuglWorldHandle handle) { world->handle = handle; } PuglWorldHandle puglGetWorldHandle(PuglWorld* world) { return world->handle; } PuglStatus puglSetWorldString(PuglWorld* const world, const PuglStringHint key, const char* const value) { if ((unsigned)key >= PUGL_NUM_STRING_HINTS) { return PUGL_BAD_PARAMETER; } puglSetString(&world->strings[key], value); return PUGL_SUCCESS; } const char* puglGetWorldString(const PuglWorld* const world, const PuglStringHint key) { if ((unsigned)key >= PUGL_NUM_STRING_HINTS) { return NULL; } return world->strings[key]; } static void puglSetDefaultHints(PuglHints hints) { hints[PUGL_CONTEXT_API] = PUGL_OPENGL_API; hints[PUGL_CONTEXT_VERSION_MAJOR] = 2; hints[PUGL_CONTEXT_VERSION_MINOR] = 0; hints[PUGL_CONTEXT_PROFILE] = PUGL_OPENGL_CORE_PROFILE; hints[PUGL_CONTEXT_DEBUG] = PUGL_FALSE; hints[PUGL_RED_BITS] = 8; hints[PUGL_GREEN_BITS] = 8; hints[PUGL_BLUE_BITS] = 8; hints[PUGL_ALPHA_BITS] = 8; hints[PUGL_DEPTH_BITS] = 0; hints[PUGL_STENCIL_BITS] = 0; hints[PUGL_SAMPLE_BUFFERS] = PUGL_DONT_CARE; hints[PUGL_SAMPLES] = 0; hints[PUGL_DOUBLE_BUFFER] = PUGL_TRUE; hints[PUGL_SWAP_INTERVAL] = PUGL_DONT_CARE; hints[PUGL_RESIZABLE] = PUGL_FALSE; hints[PUGL_IGNORE_KEY_REPEAT] = PUGL_FALSE; hints[PUGL_REFRESH_RATE] = PUGL_DONT_CARE; hints[PUGL_VIEW_TYPE] = PUGL_DONT_CARE; } PuglView* puglNewView(PuglWorld* const world) { PuglView* view = (PuglView*)calloc(1, sizeof(PuglView)); if (!view || !(view->impl = puglInitViewInternals(world))) { free(view); return NULL; } view->world = world; view->sizeHints[PUGL_MIN_SIZE].width = 1; view->sizeHints[PUGL_MIN_SIZE].height = 1; view->defaultX = INT_MIN; view->defaultY = INT_MIN; puglSetDefaultHints(view->hints); // Add to world view list ++world->numViews; world->views = (PuglView**)realloc(world->views, world->numViews * sizeof(PuglView*)); world->views[world->numViews - 1] = view; return view; } void puglFreeView(PuglView* view) { // Remove from world view list PuglWorld* world = view->world; for (size_t i = 0; i < world->numViews; ++i) { if (world->views[i] == view) { if (i == world->numViews - 1) { world->views[i] = NULL; } else { memmove(world->views + i, world->views + i + 1, sizeof(PuglView*) * (world->numViews - i - 1)); world->views[world->numViews - 1] = NULL; } --world->numViews; } } for (size_t i = 0; i < PUGL_NUM_STRING_HINTS; ++i) { free(view->strings[i]); } puglFreeViewInternals(view); free(view); } PuglWorld* puglGetWorld(PuglView* view) { return view->world; } void puglSetHandle(PuglView* view, PuglHandle handle) { view->handle = handle; } PuglHandle puglGetHandle(PuglView* view) { return view->handle; } PuglStatus puglSetBackend(PuglView* view, const PuglBackend* backend) { view->backend = backend; return PUGL_SUCCESS; } const PuglBackend* puglGetBackend(const PuglView* view) { return view->backend; } PuglStatus puglSetEventFunc(PuglView* view, PuglEventFunc eventFunc) { view->eventFunc = eventFunc; return PUGL_SUCCESS; } PuglStatus puglSetViewHint(PuglView* view, PuglViewHint hint, int value) { if (value == PUGL_DONT_CARE) { switch (hint) { case PUGL_CONTEXT_API: case PUGL_CONTEXT_VERSION_MAJOR: case PUGL_CONTEXT_VERSION_MINOR: case PUGL_CONTEXT_PROFILE: case PUGL_CONTEXT_DEBUG: case PUGL_SWAP_INTERVAL: return PUGL_BAD_PARAMETER; default: break; } } if ((unsigned)hint < PUGL_NUM_VIEW_HINTS) { view->hints[hint] = value; return PUGL_SUCCESS; } return PUGL_BAD_PARAMETER; } int puglGetViewHint(const PuglView* view, PuglViewHint hint) { if ((unsigned)hint < PUGL_NUM_VIEW_HINTS) { return view->hints[hint]; } return PUGL_DONT_CARE; } PuglStatus puglSetViewString(PuglView* const view, const PuglStringHint key, const char* const value) { if ((unsigned)key >= PUGL_NUM_STRING_HINTS) { return PUGL_BAD_PARAMETER; } puglSetString(&view->strings[key], value); return puglViewStringChanged(view, key, view->strings[key]); } const char* puglGetViewString(const PuglView* const view, const PuglStringHint key) { if ((unsigned)key >= PUGL_NUM_STRING_HINTS) { return NULL; } return view->strings[key]; } PuglRect puglGetFrame(const PuglView* view) { if (view->lastConfigure.type == PUGL_CONFIGURE) { // Return the last configured frame const PuglRect frame = {view->lastConfigure.x, view->lastConfigure.y, view->lastConfigure.width, view->lastConfigure.height}; return frame; } // Get the default position if set, or fallback to (0, 0) int x = view->defaultX; int y = view->defaultY; if (x < INT16_MIN || x > INT16_MAX || y < INT16_MIN || y > INT16_MAX) { x = 0; y = 0; } // Return the default frame, sanitized if necessary const PuglRect frame = {(PuglCoord)x, (PuglCoord)y, view->sizeHints[PUGL_DEFAULT_SIZE].width, view->sizeHints[PUGL_DEFAULT_SIZE].height}; return frame; } PuglStatus puglSetParentWindow(PuglView* view, PuglNativeView parent) { view->parent = parent; return PUGL_SUCCESS; } PuglNativeView puglGetParentWindow(const PuglView* const view) { return view->parent; } PuglNativeView puglGetTransientParent(const PuglView* const view) { return view->transientParent; } bool puglGetVisible(const PuglView* view) { return (view->lastConfigure.style & PUGL_VIEW_STYLE_MAPPED) && !(view->lastConfigure.style & PUGL_VIEW_STYLE_HIDDEN); } void* puglGetContext(PuglView* const view) { return view->backend->getContext(view); } PuglViewStyleFlags puglGetViewStyle(const PuglView* const view) { return view->lastConfigure.style; }