2012-08-18 23:31:09 -06:00
|
|
|
/*
|
|
|
|
https://github.com/peterix/dfhack
|
|
|
|
Copyright (c) 2009-2011 Petr Mrázek (peterix@gmail.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 "Export.h"
|
|
|
|
#include "Module.h"
|
|
|
|
#include "BitArray.h"
|
|
|
|
#include "ColorText.h"
|
|
|
|
#include <string>
|
|
|
|
|
|
|
|
#include "DataDefs.h"
|
|
|
|
#include "df/graphic.h"
|
|
|
|
#include "df/viewscreen.h"
|
|
|
|
|
|
|
|
/**
|
|
|
|
* \defgroup grp_screen utilities for painting to the screen
|
|
|
|
* @ingroup grp_screen
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace DFHack
|
|
|
|
{
|
|
|
|
class Core;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* The Screen module
|
|
|
|
* \ingroup grp_modules
|
|
|
|
* \ingroup grp_screen
|
|
|
|
*/
|
|
|
|
namespace Screen
|
|
|
|
{
|
|
|
|
/// Data structure describing all properties a screen tile can have
|
|
|
|
struct Pen {
|
|
|
|
// Ordinary text symbol
|
|
|
|
char ch;
|
|
|
|
int8_t fg, bg;
|
|
|
|
bool bold;
|
|
|
|
|
|
|
|
// Graphics tile
|
|
|
|
int tile;
|
|
|
|
enum TileMode {
|
|
|
|
AsIs, // Tile colors used without modification
|
|
|
|
CharColor, // The fg/bg pair is used
|
|
|
|
TileColor // The fields below are used
|
|
|
|
} tile_mode;
|
|
|
|
int8_t tile_fg, tile_bg;
|
|
|
|
|
|
|
|
Pen(char ch = 0, int8_t fg = 7, int8_t bg = 0, int tile = 0, bool color_tile = false)
|
|
|
|
: ch(ch), fg(fg&7), bg(bg), bold(!!(fg&8)),
|
|
|
|
tile(tile), tile_mode(color_tile ? CharColor : AsIs), tile_fg(0), tile_bg(0)
|
|
|
|
{}
|
|
|
|
Pen(char ch, int8_t fg, int8_t bg, bool bold, int tile = 0, bool color_tile = false)
|
|
|
|
: ch(ch), fg(fg), bg(bg), bold(bold),
|
|
|
|
tile(tile), tile_mode(color_tile ? CharColor : AsIs), tile_fg(0), tile_bg(0)
|
|
|
|
{}
|
|
|
|
Pen(char ch, int8_t fg, int8_t bg, int tile, int8_t tile_fg, int8_t tile_bg)
|
|
|
|
: ch(ch), fg(fg&7), bg(bg), bold(!!(fg&8)),
|
|
|
|
tile(tile), tile_mode(TileColor), tile_fg(tile_fg), tile_bg(tile_bg)
|
|
|
|
{}
|
|
|
|
Pen(char ch, int8_t fg, int8_t bg, bool bold, int tile, int8_t tile_fg, int8_t tile_bg)
|
|
|
|
: ch(ch), fg(fg), bg(bg), bold(bold),
|
|
|
|
tile(tile), tile_mode(TileColor), tile_fg(tile_fg), tile_bg(tile_bg)
|
|
|
|
{}
|
|
|
|
};
|
|
|
|
|
|
|
|
DFHACK_EXPORT df::coord2d getMousePos();
|
|
|
|
DFHACK_EXPORT df::coord2d getWindowSize();
|
|
|
|
|
2012-08-19 10:00:10 -06:00
|
|
|
/// Returns the state of [GRAPHICS:YES/NO]
|
|
|
|
DFHACK_EXPORT bool inGraphicsMode();
|
|
|
|
|
2012-08-18 23:31:09 -06:00
|
|
|
/// Paint one screen tile with the given pen
|
|
|
|
DFHACK_EXPORT bool paintTile(const Pen &pen, int x, int y);
|
|
|
|
|
|
|
|
/// Paint a string onto the screen. Ignores ch and tile of pen.
|
|
|
|
DFHACK_EXPORT bool paintString(const Pen &pen, int x, int y, const std::string &text);
|
|
|
|
|
|
|
|
/// Fills a rectangle with one pen. Possibly more efficient than a loop over paintTile.
|
|
|
|
DFHACK_EXPORT bool fillRect(const Pen &pen, int x1, int y1, int x2, int y2);
|
|
|
|
|
2012-08-21 14:28:11 -06:00
|
|
|
/// Draws a standard dark gray window border with a title string
|
|
|
|
DFHACK_EXPORT bool drawBorder(const std::string &title);
|
|
|
|
|
2012-08-19 04:27:44 -06:00
|
|
|
/// Wipes the screen to full black
|
|
|
|
DFHACK_EXPORT bool clear();
|
|
|
|
|
|
|
|
/// Requests repaint
|
|
|
|
DFHACK_EXPORT bool invalidate();
|
|
|
|
|
2012-08-18 23:31:09 -06:00
|
|
|
/// Find a loaded graphics tile from graphics raws.
|
|
|
|
DFHACK_EXPORT bool findGraphicsTile(const std::string &page, int x, int y, int *ptile, int *pgs = NULL);
|
|
|
|
|
|
|
|
// Push and remove viewscreens
|
|
|
|
DFHACK_EXPORT bool show(df::viewscreen *screen, df::viewscreen *before = NULL);
|
|
|
|
DFHACK_EXPORT void dismiss(df::viewscreen *screen);
|
|
|
|
DFHACK_EXPORT bool isDismissed(df::viewscreen *screen);
|
|
|
|
}
|
|
|
|
|
|
|
|
class DFHACK_EXPORT dfhack_viewscreen : public df::viewscreen {
|
|
|
|
public:
|
|
|
|
dfhack_viewscreen();
|
|
|
|
virtual ~dfhack_viewscreen();
|
|
|
|
|
|
|
|
static bool is_instance(df::viewscreen *screen);
|
|
|
|
|
2012-08-22 02:23:56 -06:00
|
|
|
virtual int8_t movies_okay() { return 1; }
|
|
|
|
virtual bool key_conflict(df::interface_key key);
|
|
|
|
|
2012-08-19 04:27:44 -06:00
|
|
|
virtual bool is_lua_screen() { return false; }
|
2012-08-18 23:31:09 -06:00
|
|
|
virtual std::string getFocusString() = 0;
|
|
|
|
};
|
2012-08-19 04:27:44 -06:00
|
|
|
|
|
|
|
class DFHACK_EXPORT dfhack_lua_viewscreen : public dfhack_viewscreen {
|
|
|
|
std::string focus;
|
|
|
|
|
|
|
|
void update_focus(lua_State *L, int idx);
|
|
|
|
|
|
|
|
bool safe_call_lua(int (*pf)(lua_State *), int args, int rvs);
|
|
|
|
static dfhack_lua_viewscreen *get_self(lua_State *L);
|
|
|
|
|
|
|
|
static int do_destroy(lua_State *L);
|
|
|
|
static int do_render(lua_State *L);
|
|
|
|
static int do_notify(lua_State *L);
|
|
|
|
static int do_input(lua_State *L);
|
|
|
|
|
|
|
|
public:
|
|
|
|
dfhack_lua_viewscreen(lua_State *L, int table_idx);
|
|
|
|
virtual ~dfhack_lua_viewscreen();
|
|
|
|
|
|
|
|
static df::viewscreen *get_pointer(lua_State *L, int idx, bool make);
|
|
|
|
|
|
|
|
virtual bool is_lua_screen() { return true; }
|
|
|
|
virtual std::string getFocusString() { return focus; }
|
|
|
|
|
|
|
|
virtual void render();
|
|
|
|
virtual void logic();
|
|
|
|
virtual void help();
|
|
|
|
virtual void resize(int w, int h);
|
|
|
|
virtual void feed(std::set<df::interface_key> *keys);
|
|
|
|
};
|
2012-08-18 23:31:09 -06:00
|
|
|
}
|