aliceml.h

説明を見る。

/*
 * Copyright (c) 2005-2007  cielacanth <cielacanth AT s60.xrea.com>
 * All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *    1. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *    2. Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 */

#ifndef __ALICEML_H__
#define __ALICEML_H__

#include "aliceml_config.h"
#include "aliceml_color.h"
#include "aliceml_rect.h"
#include "aliceml_string.h"

#ifdef __cplusplus
extern "C" {
#endif

typedef enum ML_BoolIdentifier {
    ML_VERTICAL,
    ML_CONTINUE_TO_PAUSE,
    ML_WAIT,
    ML_PAUSE,
    ML_AUTO_NEWLINE,
    ML_AUTO_NEWPAGE,
    ML_CHAR_AUTO_HIDE,
    ML_CHAR_SHOWING,
    ML_CHAR_HIDING,
    ML_AUTO_REFRESH,
} ML_BoolIdentifier;

typedef enum ML_IntIdentifier {
    ML_AUTOMODE_NEWLINE_WAIT,
    ML_AUTOMODE_NEWPAGE_WAIT,
    ML_AUTOMODE_PAUSE_WAIT,
    
    ML_TEXT_ALIGN,
    ML_LINE_SPACE,
    ML_CHAR_SPACE,

    ML_FONT_SIZE,
    ML_FONT_STYLE,
    ML_RUBY_SIZE,
    ML_RUBY_OFFSET,

    ML_TEXT_SPEED,
    ML_CHAR_SHOW_TIME,
    ML_CHAR_SHOWING_TIME,
    ML_CHAR_HIDING_TIME,
} ML_IntIdentifier;

typedef enum ML_Mode {
    ML_MODE_NORMAL,
    ML_MODE_AUTO,
    ML_MODE_SKIP,
    ML_MODE_SUSPEND,
} ML_Mode;

typedef enum ML_TextAlign {
    ML_ALIGN_CENTER,
    ML_ALIGN_TOP,
    ML_ALIGN_BOTTOM,
    ML_ALIGN_LEFT = ML_ALIGN_TOP,
    ML_ALIGN_RIGHT = ML_ALIGN_BOTTOM,
} ML_TextAlign;

typedef int ML_FontStyle;
#define ML_FONTSTYLE_REGULAR    0x0000
#define ML_FONTSTYLE_BOLD       0x0001
#define ML_FONTSTYLE_ITALIC     0x0002
#define ML_FONTSTYLE_UNDERLINE  0x0004
#define ML_FONTSTYLE_SHADOW     0x0008
#define ML_FONTSTYLE_HEMMING    0x0010
#define ML_FONTSTYLE_VERTICAL   0x0020

/* 前方宣言。*/
typedef struct ML_Message ML_Message;
typedef struct ML_Backend ML_Backend;
typedef struct ML_Surface ML_Surface;
typedef struct ML_Command ML_Command;
typedef struct ML_Font ML_Font;

typedef void (ALICEMLCALL *ML_Callback)(ML_Message *message);

typedef int (ALICEMLCALL *ML_Callback_Insert)(void *elem);

typedef void (ALICEMLCALL *ML_Callback_Remove)(void *elem);

typedef int (ALICEMLCALL *ML_Comparator)(const void *elem1, const void *elem2);

typedef void (ALICEMLCALL *ML_Callback_Text)(ML_Message *message);

#define ML_has_flag(var, flag) (((var) & (flag)) != 0)

#define ML_abs(x) ((x) >= 0 ? (x) : -(x))

#define ML_max(x, y) ((x) > (y) ? (x) : (y))

#define ML_min(x, y) ((x) < (y) ? (x) : (y))

#define ML_median(x, min_value, max_value) ML_min((max_value), ML_max((min_value), (x)))

ALICEMLAPI void * ALICEMLCALL ML_malloc(ML_size size);

ALICEMLAPI void ALICEMLCALL ML_free(void *ptr);

ALICEMLAPI void * ALICEMLCALL ML_pooled_malloc(ML_size size);

ALICEMLAPI void ALICEMLCALL ML_pooled_free(void *ptr);


ALICEMLAPI ML_Message * ALICEMLCALL ML_CreateMessage(ML_Surface *surface);

ALICEMLAPI ML_Message * ALICEMLCALL ML_CreateMessageWithSharedSurface(ML_Surface *surface);

ALICEMLAPI void ALICEMLCALL ML_DestroyMessage(ML_Message *message);

ALICEMLAPI ML_Surface * ML_CreateSurfaceFromBackend(ML_Backend *backend, void *abstract_surface);

ALICEMLAPI void ALICEMLCALL ML_DestroySurface(ML_Surface *surface);

ALICEMLAPI ML_Surface * ALICEMLCALL ML_GetSurface(ML_Message *message);

ALICEMLAPI void ALICEMLCALL ML_SetPrivateData(ML_Message *message, void *data);

ALICEMLAPI void * ALICEMLCALL ML_GetPrivateData(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_Enable(ML_Message *message, ML_BoolIdentifier id);

ALICEMLAPI int ALICEMLCALL ML_Disable(ML_Message *message, ML_BoolIdentifier id);

ALICEMLAPI int ALICEMLCALL ML_SetBool(ML_Message *message, ML_BoolIdentifier id, ML_bool value);

ALICEMLAPI ML_bool ALICEMLCALL ML_IsEnabled(ML_Message *message, ML_BoolIdentifier id);

ALICEMLAPI ML_bool ALICEMLCALL ML_IsDisabled(ML_Message *message, ML_BoolIdentifier id);

#define ML_GetBool ML_IsEnabled

ALICEMLAPI int ALICEMLCALL ML_SetInteger(ML_Message *message, ML_IntIdentifier id, int value);

ALICEMLAPI int ALICEMLCALL ML_GetInteger(ML_Message *message, ML_IntIdentifier id, int *value);

ALICEMLAPI int ALICEMLCALL ML_PushContext(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_PopContext(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_PushFont(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_PopFont(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_SetMode(ML_Message *message, ML_Mode mode);

ALICEMLAPI int ALICEMLCALL ML_SetAutoModeWait(ML_Message *message, int newline_wait, int newpage_wait, int pause_wait);

ALICEMLAPI int ALICEMLCALL ML_SetNextCharTime(ML_Message *message, int next_char_time);

ALICEMLAPI int ALICEMLCALL ML_SetTextShowTime(ML_Message *message, int char_showing_time, int char_show_time, int char_hiding_time);

ALICEMLAPI int ALICEMLCALL ML_SetLineStyle(ML_Message *message, ML_TextAlign align, int line_space, int char_space);

ALICEMLAPI int ALICEMLCALL ML_SetDefaultFontFace(ML_Message *message, int index);

ALICEMLAPI int ALICEMLCALL ML_SetFontFaceFromStr(ML_Message *message, const char *font_name, int index, ML_bool is_fullpath);

ALICEMLAPI int ALICEMLCALL ML_SetFontFaceFromString(ML_Message *message, ML_String8 *font_name, int index, ML_bool is_fullpath);

ALICEMLAPI int ALICEMLCALL ML_SetFontSize(ML_Message *message, int size);

ALICEMLAPI int ALICEMLCALL ML_SetFontStyle(ML_Message *message, ML_FontStyle style);

ALICEMLAPI int ALICEMLCALL ML_SetFontColor4ub(ML_Message *message, ML_uint8 r, ML_uint8 g, ML_uint8 b, ML_uint8 a);

ALICEMLAPI int ALICEMLCALL ML_SetShadowColor4ub(ML_Message *message, ML_uint8 r, ML_uint8 g, ML_uint8 b, ML_uint8 a);

ALICEMLAPI int ALICEMLCALL ML_SetShadowOffset(ML_Message *message, int offset_x, int offset_y);

ALICEMLAPI int ALICEMLCALL ML_SetHemmingColor4ub(ML_Message *message, ML_uint8 r, ML_uint8 g, ML_uint8 b, ML_uint8 a);

ALICEMLAPI int ALICEMLCALL ML_SetHemmingWidth(ML_Message *message, int width_x, int width_y);

ALICEMLAPI int ALICEMLCALL ML_SetRubyStyle(ML_Message *message, int ruby_size, int ruby_offset);

ALICEMLAPI int ALICEMLCALL ML_SetPosition(ML_Message *message, int left, int top);

ALICEMLAPI int ALICEMLCALL ML_SetSize(ML_Message *message, int width, int height);

ALICEMLAPI int ALICEMLCALL ML_SetBounds(ML_Message *message, int left, int top, int width, int height);

ALICEMLAPI int ALICEMLCALL ML_SetMargin(ML_Message *message, int marginl, int margint, int marginr, int marginb);

ALICEMLAPI int ALICEMLCALL ML_SetCallbackText(ML_Message *message, ML_Callback_Text callback);

ALICEMLAPI int ALICEMLCALL ML_Update(ML_Message *message, int dt);

ALICEMLAPI int ALICEMLCALL ML_Refresh(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_NextPage(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_PrevPage(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_SetLastPage(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_Background(ML_Message *message, int dt, ML_bool is_sleep);

ALICEMLAPI int ALICEMLCALL ML_Continue(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_DrawText(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_SetLastPage(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_AddCharUCS4(ML_Message *message, ML_char32 c);
ALICEMLAPI int ALICEMLCALL ML_AddCharUTF16(ML_Message *message, ML_char16 c);
ALICEMLAPI int ALICEMLCALL ML_AddCharUTF8(ML_Message *message, ML_char8 c);

ALICEMLAPI int ALICEMLCALL ML_AddTextlUCS4(ML_Message *message, const ML_char32 *text, ML_size length);
ALICEMLAPI int ALICEMLCALL ML_AddTextlUTF16(ML_Message *message, const ML_char16 *text, ML_size length);
ALICEMLAPI int ALICEMLCALL ML_AddTextlUTF8(ML_Message *message, const ML_char8 *text, ML_size length);

ALICEMLAPI int ALICEMLCALL ML_AddTextUCS4(ML_Message *message, const ML_char32 *text);
ALICEMLAPI int ALICEMLCALL ML_AddTextUTF16(ML_Message *message, const ML_char16 *text);
ALICEMLAPI int ALICEMLCALL ML_AddTextUTF8(ML_Message *message, const ML_char8 *text);

ALICEMLAPI int ALICEMLCALL ML_AddTextWithRubyUCS4(ML_Message *message, const ML_char32 *text, const ML_char32 *reading);
ALICEMLAPI int ALICEMLCALL ML_AddTextWithRubyUTF16(ML_Message *message, const ML_char16 *text, const ML_char16 *reading);
ALICEMLAPI int ALICEMLCALL ML_AddTextWithRubyUTF8(ML_Message *message, const ML_char8 *text, const ML_char8 *reading);

ALICEMLAPI int ALICEMLCALL ML_AddLinklUCS4(ML_Message *message, int id, const ML_char32 *text, ML_size length);
ALICEMLAPI int ALICEMLCALL ML_AddLinklUTF16(ML_Message *message, int id, const ML_char16 *text, ML_size length);
ALICEMLAPI int ALICEMLCALL ML_AddLinklUTF8(ML_Message *message, int id, const ML_char8 *text, ML_size length);

ALICEMLAPI int ALICEMLCALL ML_AddLinkUCS4(ML_Message *message, int id, const ML_char32 *text);
ALICEMLAPI int ALICEMLCALL ML_AddLinkUTF16(ML_Message *message, int id, const ML_char16 *text);
ALICEMLAPI int ALICEMLCALL ML_AddLinkUTF8(ML_Message *message, int id, const ML_char8 *text);

#if ML_WCHAR_SIZE == 4
#define ML_AddCharWChar     ML_AddCharUCS4
#define ML_AddTextlWChar    ML_AddTextlUCS4
#define ML_AddTextWChar     ML_AddTextUCS4
#define ML_AddLinklWChar    ML_AddLinklUCS4
#define ML_AddLinkWChar     ML_AddLinkUCS4
#define ML_AddTextWithRubyWChar ML_AddTextWithRubyUCS4
#else
#define ML_AddCharWChar     ML_AddCharUTF16
#define ML_AddTextlWChar    ML_AddTextlUTF16
#define ML_AddTextWChar     ML_AddTextUTF16
#define ML_AddLinklWChar    ML_AddLinklUTF16
#define ML_AddLinkWChar     ML_AddLinkUTF16
#define ML_AddTextWithRubyWChar ML_AddTextWithRubyUTF16
#endif

/* ALICEMLAPI int ALICEMLCALL ML_AddHorizontalText(ML_Message *message, const char *text, ML_bool expand);*/

ALICEMLAPI int ALICEMLCALL ML_AddCommand(ML_Message *message, ML_Command *command);

ALICEMLAPI int ALICEMLCALL ML_AddNewLine(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_AddNewPage(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_AddPause(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_AddWait(ML_Message *message, int time, ML_bool can_skip);

ALICEMLAPI int ALICEMLCALL ML_MakeHistory(ML_Message *from, ML_Message *to);

ALICEMLAPI int ALICEMLCALL ML_Clear(ML_Message *message);

ALICEMLAPI ML_bool ALICEMLCALL ML_IsCommandFull(ML_Message *message);

ALICEMLAPI ML_size ALICEMLCALL ML_GetCommandSize(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_AddAvoidRect(ML_Message *message, ML_Rect *rect);

ALICEMLAPI int ALICEMLCALL ML_GetAvoidRectSize(ML_Message *message);

ALICEMLAPI ML_Rect * ALICEMLCALL ML_GetAvoidRect(ML_Message *message, int i);

ALICEMLAPI void ALICEMLCALL ML_ClearAvoidRect(ML_Message *message);

ALICEMLAPI int ALICEMLCALL ML_AddDirtyRect(ML_Message *message, ML_Rect *rect);

ALICEMLAPI int ALICEMLCALL ML_GetDirtyRectSize(ML_Message *message);

ALICEMLAPI ML_Rect * ALICEMLCALL ML_GetDirtyRect(ML_Message *message, int i);

ALICEMLAPI ML_bool ALICEMLCALL ML_IntersectDirtyRect(ML_Message *message, ML_Rect *rect);

ALICEMLAPI int ALICEMLCALL ML_GetLinkID(ML_Message *message, int x, int y);


ALICEMLAPI void ALICEMLCALL ML_SetError(const char *format, ...);

ALICEMLAPI const char * ALICEMLCALL ML_GetError();

ALICEMLAPI void ALICEMLCALL ML_ClearError();

ALICEMLAPI int ALICEMLCALL ML_CheckMemory();

ALICEMLAPI ML_String8 * ALICEMLCALL ML_MakeFontPath(const ML_char8 *fontfile);

ALICEMLAPI ML_String8 * ALICEMLCALL ML_GetDefaultFont();

ALICEMLAPI ML_uint32 ALICEMLCALL ML_GetTicks();

ALICEMLAPI int ALICEMLCALL ML_Delay(ML_uint32 time);

#ifdef __cplusplus
}
#endif

#endif

---