Text.h

Go to the documentation of this file.

/*
 * ObjectivelyMVC: Object oriented MVC framework for SDL3 and C.
 * Copyright (C) 2014 Jay Dolan <jay@jaydolan.com>
 *
 * This software is provided 'as-is', without any express or implied
 * warranty. In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 * claim that you wrote the original software. If you use this software
 * in a product, an acknowledgment in the product documentation would be
 * appreciated but is not required.
 *
 * 2. Altered source versions must be plainly marked as such, and must not be
 * misrepresented as being the original software.
 *
 * 3. This notice may not be removed or altered from any source distribution.
 */
 
#pragma once
 
#include <SDL3/SDL_gpu.h>
 
#include <ObjectivelyMVC/Font.h>
#include <ObjectivelyMVC/ImageAtlas.h>
#include <ObjectivelyMVC/View.h>
 
OBJECTIVELYMVC_EXPORT SDL_Color TextEscapeColors[10];
 
OBJECTIVELYMVC_EXPORT bool MVC_HasColorEscapes(const char *text);
 
OBJECTIVELYMVC_EXPORT char *MVC_StripColorEscapes(const char *text);
 
typedef enum {
  TextTransformNone,
  TextTransformUppercase,
  TextTransformLowercase,
  TextTransformCapitalize
} TextTransform;
 
OBJECTIVELYMVC_EXPORT const EnumName TextTransformNames[];
 
OBJECTIVELYMVC_EXPORT size_t MVC_IconEscapeLength(const char *chars, const ImageAtlas *icons, AtlasImage **image);
 
typedef struct {
  int offset;
  int length;
  SDL_Color color;
  AtlasImage *icon;
} TextSpan;
 
OBJECTIVELYMVC_EXPORT char *MVC_LayoutText(const Font *font, const char *text, SDL_Color color, const ImageAtlas *icons, TextSpan **spans, size_t *count);
 
typedef struct {
  SDL_Rect src;
  SDL_Color color;
  AtlasImage *icon;
} TextRun;
 
typedef struct Text Text;
typedef struct TextInterface TextInterface;
 
struct Text {
 
  View view;
 
  TextInterface *interface[0];
 
  SDL_Color color;
 
  Font *font;
 
  bool lineWrap;
 
  struct {
    SDL_Size size;
    float pixelDensity;
    bool isValid;
  } naturalSizeCache;
 
  struct {
    const ImageAtlas *atlas;
    unsigned generation;
  } icons;
 
  TextRun *runs;
 
  size_t runCount;
 
  char *text;
 
  Texture *texture;
 
  TextTransform transform;
 
  char *transformed;
 
};
 
struct TextInterface {
 
  ViewInterface viewInterface;
 
  Text *(*initWithText)(Text *self, const char *text, Font *font);
 
  SDL_Size (*naturalSize)(const Text *self);
 
  SDL_Size (*sizeText)(const Text *self, const char *text);
 
  void (*setFont)(Text *self, Font *font);
 
  void (*setText)(Text *self, const char *text);
 
  void (*setTextWithFormat)(Text *self, const char *fmt, ...);
 
  void (*setTransform)(Text *self, TextTransform transform);
};
 
OBJECTIVELYMVC_EXPORT Class *_Text(void);