370 lines
15 KiB
C++
370 lines
15 KiB
C++
/*
|
||
* Portions of this file are copyright Rebirth contributors and licensed as
|
||
* described in COPYING.txt.
|
||
* Portions of this file are copyright Parallax Software and licensed
|
||
* according to the Parallax license below.
|
||
* See COPYING.txt for license details.
|
||
|
||
THE COMPUTER CODE CONTAINED HEREIN IS THE SOLE PROPERTY OF PARALLAX
|
||
SOFTWARE CORPORATION ("PARALLAX"). PARALLAX, IN DISTRIBUTING THE CODE TO
|
||
END-USERS, AND SUBJECT TO ALL OF THE TERMS AND CONDITIONS HEREIN, GRANTS A
|
||
ROYALTY-FREE, PERPETUAL LICENSE TO SUCH END-USERS FOR USE BY SUCH END-USERS
|
||
IN USING, DISPLAYING, AND CREATING DERIVATIVE WORKS THEREOF, SO LONG AS
|
||
SUCH USE, DISPLAY OR CREATION IS FOR NON-COMMERCIAL, ROYALTY OR REVENUE
|
||
FREE PURPOSES. IN NO EVENT SHALL THE END-USER USE THE COMPUTER CODE
|
||
CONTAINED HEREIN FOR REVENUE-BEARING PURPOSES. THE END-USER UNDERSTANDS
|
||
AND AGREES TO THE TERMS HEREIN AND ACCEPTS THE SAME BY USE OF THIS FILE.
|
||
COPYRIGHT 1993-1999 PARALLAX SOFTWARE CORPORATION. ALL RIGHTS RESERVED.
|
||
*/
|
||
|
||
/*
|
||
*
|
||
* Routines for menus.
|
||
*
|
||
*/
|
||
|
||
|
||
#ifndef _NEWMENU_H
|
||
#define _NEWMENU_H
|
||
|
||
#include "event.h"
|
||
|
||
#ifdef __cplusplus
|
||
#include <algorithm>
|
||
#include "varutil.h"
|
||
#include "dxxsconf.h"
|
||
#include "fmtcheck.h"
|
||
|
||
struct newmenu;
|
||
struct listbox;
|
||
|
||
#define NM_TYPE_MENU 0 // A menu item... when enter is hit on this, newmenu_do returns this item number
|
||
#define NM_TYPE_INPUT 1 // An input box... fills the text field in, and you need to fill in text_len field.
|
||
#define NM_TYPE_CHECK 2 // A check box. Set and get its status by looking at flags field (1=on, 0=off)
|
||
#define NM_TYPE_RADIO 3 // Same as check box, but only 1 in a group can be set at a time. Set group fields.
|
||
#define NM_TYPE_TEXT 4 // A line of text that does nothing.
|
||
#define NM_TYPE_NUMBER 5 // A numeric entry counter. Changes value from min_value to max_value;
|
||
#define NM_TYPE_INPUT_MENU 6 // A inputbox that you hit Enter to edit, when done, hit enter and menu leaves.
|
||
#define NM_TYPE_SLIDER 7 // A slider from min_value to max_value. Draws with text_len chars.
|
||
|
||
#define NM_MAX_TEXT_LEN 255
|
||
|
||
struct newmenu_item
|
||
{
|
||
int type; // What kind of item this is, see NM_TYPE_????? defines
|
||
int value; // For checkboxes and radio buttons, this is 1 if marked initially, else 0
|
||
int min_value, max_value; // For sliders and number bars.
|
||
int group; // What group this belongs to for radio buttons.
|
||
int text_len; // The maximum length of characters that can be entered by this inputboxes
|
||
char *text; // The text associated with this item.
|
||
// The rest of these are used internally by by the menu system, so don't set 'em!!
|
||
short x, y;
|
||
short w, h;
|
||
short right_offset;
|
||
char saved_text[NM_MAX_TEXT_LEN+1];
|
||
};
|
||
|
||
template <typename T>
|
||
class newmenu_subfunction_t
|
||
{
|
||
public:
|
||
typedef int (*type)(newmenu *menu, d_event *event, T *userdata);
|
||
};
|
||
|
||
typedef newmenu_subfunction_t<void>::type newmenu_subfunction;
|
||
|
||
class unused_newmenu_userdata_t;
|
||
static const newmenu_subfunction_t<unused_newmenu_userdata_t>::type unused_newmenu_subfunction = NULL;
|
||
static unused_newmenu_userdata_t *const unused_newmenu_userdata = NULL;
|
||
|
||
int newmenu_do2(const char *title, const char *subtitle, int nitems, newmenu_item *item, newmenu_subfunction subfunction, void *userdata, int citem, const char *filename);
|
||
|
||
// Pass an array of newmenu_items and it processes the menu. It will
|
||
// return a -1 if Esc is pressed, otherwise, it returns the index of
|
||
// the item that was current when Enter was was selected.
|
||
// The subfunction function accepts standard events, plus additional
|
||
// NEWMENU events in future. Just pass NULL if you don't want this,
|
||
// or return 0 where you don't want to override the default behaviour.
|
||
// Title draws big, Subtitle draw medium sized. You can pass NULL for
|
||
// either/both of these if you don't want them.
|
||
// Same as above, only you can pass through what background bitmap to use.
|
||
template <typename T>
|
||
int newmenu_do2(const char *title, const char *subtitle, int nitems, newmenu_item *item, typename newmenu_subfunction_t<T>::type subfunction, T *userdata, int citem, const char *filename)
|
||
{
|
||
return newmenu_do2(title, subtitle, nitems, item, (newmenu_subfunction_t<void>::type)subfunction, (void *)userdata, citem, filename );
|
||
}
|
||
|
||
template <typename T>
|
||
static inline int newmenu_do( const char * title, const char * subtitle, int nitems, newmenu_item * item, typename newmenu_subfunction_t<T>::type subfunction, T *userdata )
|
||
{
|
||
return newmenu_do2( title, subtitle, nitems, item, subfunction, userdata, 0, NULL );
|
||
}
|
||
|
||
// Same as above, only you can pass through what item is initially selected.
|
||
template <typename T>
|
||
static inline int newmenu_do1( const char * title, const char * subtitle, int nitems, newmenu_item * item, typename newmenu_subfunction_t<T>::type subfunction, T *userdata, int citem )
|
||
{
|
||
return newmenu_do2( title, subtitle, nitems, item, subfunction, userdata, citem, NULL );
|
||
}
|
||
|
||
newmenu *newmenu_do4( const char * title, const char * subtitle, int nitems, newmenu_item * item, newmenu_subfunction subfunction, void *userdata, int citem, const char * filename, int TinyMode, int TabsFlag );
|
||
|
||
static inline newmenu *newmenu_do3( const char * title, const char * subtitle, int nitems, newmenu_item * item, newmenu_subfunction subfunction, void *userdata, int citem, const char * filename )
|
||
{
|
||
return newmenu_do4( title, subtitle, nitems, item, subfunction, userdata, citem, filename, 0, 0 );
|
||
}
|
||
|
||
// Same as above, but returns menu instead of citem
|
||
template <typename T>
|
||
static newmenu *newmenu_do3(const char *title, const char *subtitle, int nitems, newmenu_item *item, typename newmenu_subfunction_t<T>::type subfunction, T *userdata, int citem, const char *filename)
|
||
{
|
||
return newmenu_do3(title, subtitle, nitems, item, (newmenu_subfunction_t<void>::type)subfunction, (void *)userdata, citem, filename);
|
||
}
|
||
|
||
static inline newmenu *newmenu_dotiny( const char * title, const char * subtitle, int nitems, newmenu_item * item, int TabsFlag, newmenu_subfunction subfunction, void *userdata )
|
||
{
|
||
return newmenu_do4( title, subtitle, nitems, item, subfunction, userdata, 0, NULL, 1, TabsFlag );
|
||
}
|
||
|
||
// Tiny menu with GAME_FONT
|
||
template <typename T>
|
||
static newmenu *newmenu_dotiny(const char * title, const char * subtitle, int nitems, newmenu_item * item, int TabsFlag, typename newmenu_subfunction_t<T>::type subfunction, T *userdata)
|
||
{
|
||
return newmenu_dotiny(title, subtitle, nitems, item, TabsFlag, (newmenu_subfunction_t<void>::type)subfunction, (void *)userdata);
|
||
}
|
||
|
||
// Basically the same as do2 but sets reorderitems flag for weapon priority menu a bit redundant to get lose of a global variable but oh well...
|
||
extern int newmenu_doreorder(const char * title, const char * subtitle, int nitems, newmenu_item *item, newmenu_subfunction, void *userdata);
|
||
|
||
// Sample Code:
|
||
/*
|
||
{
|
||
int mmn;
|
||
newmenu_item mm[8];
|
||
char xtext[21];
|
||
|
||
strcpy( xtext, "John" );
|
||
|
||
mm[0].type=NM_TYPE_MENU; mm[0].text="Play game";
|
||
mm[1].type=NM_TYPE_INPUT; mm[1].text=xtext; mm[1].text_len=20;
|
||
mm[2].type=NM_TYPE_CHECK; mm[2].value=0; mm[2].text="check box";
|
||
mm[3].type=NM_TYPE_TEXT; mm[3].text="-pickone-";
|
||
mm[4].type=NM_TYPE_RADIO; mm[4].value=1; mm[4].group=0; mm[4].text="Radio #1";
|
||
mm[5].type=NM_TYPE_RADIO; mm[5].value=1; mm[5].group=0; mm[5].text="Radio #2";
|
||
mm[6].type=NM_TYPE_RADIO; mm[6].value=1; mm[6].group=0; mm[6].text="Radio #3";
|
||
mm[7].type=NM_TYPE_PERCENT; mm[7].value=50; mm[7].text="Volume";
|
||
|
||
mmn = newmenu_do("Descent", "Sample Menu", 8, mm, NULL );
|
||
}
|
||
|
||
*/
|
||
|
||
// This function pops up a messagebox and returns which choice was selected...
|
||
// Example:
|
||
// nm_messagebox( "Title", "Subtitle", 2, "Ok", "Cancel", "There are %d objects", nobjects );
|
||
// Returns 0 through nchoices-1.
|
||
//int nm_messagebox(const char *title, int nchoices, ...);
|
||
#define nm_messagebox(T,N,...) nm_messagebox_a##N((T), ##__VA_ARGS__)
|
||
#define nm_messagebox_a1(T,A1 ,F,...) vnm_messagebox_aN(T,nm_messagebox_tie(A1 ),F,##__VA_ARGS__)
|
||
#define nm_messagebox_a2(T,A1,A2 ,F,...) vnm_messagebox_aN(T,nm_messagebox_tie(A1,A2 ),F,##__VA_ARGS__)
|
||
#define nm_messagebox_a3(T,A1,A2,A3 ,F,...) vnm_messagebox_aN(T,nm_messagebox_tie(A1,A2,A3 ),F,##__VA_ARGS__)
|
||
#define nm_messagebox_a4(T,A1,A2,A3,A4 ,F,...) vnm_messagebox_aN(T,nm_messagebox_tie(A1,A2,A3,A4 ),F,##__VA_ARGS__)
|
||
#define nm_messagebox_a5(T,A1,A2,A3,A4,A5 ,F,...) vnm_messagebox_aN(T,nm_messagebox_tie(A1,A2,A3,A4,A5),F,##__VA_ARGS__)
|
||
|
||
typedef cstring_tie<5> nm_messagebox_tie;
|
||
|
||
int nm_messagebox_str(const char *title, const nm_messagebox_tie &tie, const char *str) __attribute_nonnull((3));
|
||
int vnm_messagebox_aN(const char *title, const nm_messagebox_tie &tie, const char *format, ...) __attribute_format_printf(3, 4);
|
||
#define vnm_messagebox_aN(A1,A2,F,...) dxx_call_printf_checked(vnm_messagebox_aN,nm_messagebox_str,(A1,A2),(F),##__VA_ARGS__)
|
||
|
||
newmenu_item *newmenu_get_items(newmenu *menu);
|
||
int newmenu_get_nitems(newmenu *menu);
|
||
int newmenu_get_citem(newmenu *menu);
|
||
struct window *newmenu_get_window(newmenu *menu);
|
||
void nm_draw_background(int x1, int y1, int x2, int y2);
|
||
void nm_restore_background(int x, int y, int w, int h);
|
||
|
||
extern const char *Newmenu_allowed_chars;
|
||
|
||
// Example listbox callback function...
|
||
// int lb_callback( int * citem, int *nitems, char * items[], int *keypress )
|
||
// {
|
||
// int i;
|
||
//
|
||
// if ( *keypress = KEY_CTRLED+KEY_D ) {
|
||
// if ( *nitems > 1 ) {
|
||
// unlink( items[*citem] ); // Delete the file
|
||
// for (i=*citem; i<*nitems-1; i++ ) {
|
||
// items[i] = items[i+1];
|
||
// }
|
||
// *nitems = *nitems - 1;
|
||
// free( items[*nitems] );
|
||
// items[*nitems] = NULL;
|
||
// return 1; // redraw;
|
||
// }
|
||
// *keypress = 0;
|
||
// }
|
||
// return 0;
|
||
// }
|
||
|
||
extern const char **listbox_get_items(listbox *lb);
|
||
extern int listbox_get_nitems(listbox *lb);
|
||
extern int listbox_get_citem(listbox *lb);
|
||
struct window *listbox_get_window(listbox *lb);
|
||
extern void listbox_delete_item(listbox *lb, int item);
|
||
|
||
template <typename T>
|
||
class listbox_subfunction_t
|
||
{
|
||
public:
|
||
typedef int (*type)(listbox *menu, d_event *event, T *userdata);
|
||
};
|
||
|
||
class unused_listbox_userdata_t;
|
||
static listbox_subfunction_t<unused_listbox_userdata_t>::type *const unused_listbox_subfunction = NULL;
|
||
static unused_listbox_userdata_t *const unused_listbox_userdata = NULL;
|
||
|
||
listbox *newmenu_listbox1( const char * title, int nitems, const char *items[], int allow_abort_flag, int default_item, listbox_subfunction_t<void>::type listbox_callback, void *userdata );
|
||
|
||
template <typename T>
|
||
listbox *newmenu_listbox1(const char *title, int nitems, const char *items[], int allow_abort_flag, int default_item, typename listbox_subfunction_t<T>::type listbox_callback, T *userdata)
|
||
{
|
||
return newmenu_listbox1(title, nitems, items, allow_abort_flag, default_item, (listbox_subfunction_t<void>::type)listbox_callback, (void *)userdata);
|
||
}
|
||
|
||
template <typename T>
|
||
listbox *newmenu_listbox(const char *title, int nitems, const char *items[], int allow_abort_flag, typename listbox_subfunction_t<T>::type listbox_callback, T *userdata)
|
||
{
|
||
return newmenu_listbox1(title, nitems, items, allow_abort_flag, 0, (listbox_subfunction_t<void>::type)listbox_callback, (void *)userdata);
|
||
}
|
||
|
||
//should be called whenever the palette changes
|
||
extern void newmenu_free_background();
|
||
|
||
static inline void nm_set_item_menu(newmenu_item *ni, const char *text)
|
||
{
|
||
ni->type = NM_TYPE_MENU;
|
||
ni->text = (char *)text;
|
||
}
|
||
|
||
static inline void nm_set_item_input(newmenu_item *ni, unsigned len, char *text)
|
||
{
|
||
ni->type = NM_TYPE_INPUT;
|
||
ni->text = text;
|
||
ni->text_len = len;
|
||
}
|
||
|
||
static inline void nm_set_item_checkbox(newmenu_item *ni, const char *text, unsigned checked)
|
||
{
|
||
ni->type = NM_TYPE_CHECK;
|
||
ni->text = (char *)text;
|
||
ni->value = checked;
|
||
}
|
||
|
||
static inline void nm_set_item_text(newmenu_item *ni, const char *text)
|
||
{
|
||
ni->type = NM_TYPE_TEXT;
|
||
ni->text = (char *)text;
|
||
}
|
||
|
||
static inline void nm_set_item_radio(newmenu_item *ni, const char *text, unsigned checked, unsigned grp)
|
||
{
|
||
ni->type = NM_TYPE_RADIO;
|
||
ni->text = (char *)text;
|
||
ni->value = checked;
|
||
ni->group = grp;
|
||
}
|
||
|
||
static inline void nm_set_item_number(newmenu_item *ni, const char *text, unsigned now, unsigned low, unsigned high)
|
||
{
|
||
ni->type = NM_TYPE_NUMBER;
|
||
ni->text = (char *)text;
|
||
ni->value = now;
|
||
ni->min_value = low;
|
||
ni->max_value = high;
|
||
}
|
||
|
||
static inline void nm_set_item_slider(newmenu_item *ni, const char *text, unsigned now, unsigned low, unsigned high)
|
||
{
|
||
ni->type = NM_TYPE_SLIDER;
|
||
ni->text = (char *)text;
|
||
ni->value = now;
|
||
ni->min_value = low;
|
||
ni->max_value = high;
|
||
}
|
||
|
||
#define NEWMENU_MOUSE
|
||
|
||
// #define NORMAL_CHECK_BOX "<22>"
|
||
// #define CHECKED_CHECK_BOX "<22>"
|
||
//
|
||
// #define NORMAL_RADIO_BOX ""
|
||
// #define CHECKED_RADIO_BOX "<22>"
|
||
// #define CURSOR_STRING "_"
|
||
// #define SLIDER_LEFT "<22>" // 131
|
||
// #define SLIDER_RIGHT "<22>" // 132
|
||
// #define SLIDER_MIDDLE "<22>" // 133
|
||
// #define SLIDER_MARKER "<22>" // 134
|
||
// #define UP_ARROW_MARKER "<22>" // 135
|
||
// #define DOWN_ARROW_MARKER "<22>" // 136
|
||
#define NORMAL_CHECK_BOX "\201"
|
||
#define CHECKED_CHECK_BOX "\202"
|
||
|
||
#define NORMAL_RADIO_BOX "\177"
|
||
#define CHECKED_RADIO_BOX "\200"
|
||
#define CURSOR_STRING "_"
|
||
#define SLIDER_LEFT "\203" // 131
|
||
#define SLIDER_RIGHT "\204" // 132
|
||
#define SLIDER_MIDDLE "\205" // 133
|
||
#define SLIDER_MARKER "\206" // 134
|
||
#if defined(DXX_BUILD_DESCENT_I)
|
||
#define UP_ARROW_MARKER "+" // 135
|
||
#define DOWN_ARROW_MARKER "+" // 136
|
||
#elif defined(DXX_BUILD_DESCENT_II)
|
||
#define UP_ARROW_MARKER ((grd_curcanv->cv_font==GAME_FONT.get())?"\202":"\207") // 135
|
||
#define DOWN_ARROW_MARKER ((grd_curcanv->cv_font==GAME_FONT.get())?"\200":"\210") // 136
|
||
#endif
|
||
|
||
#define BORDERX (15*(SWIDTH/320))
|
||
#define BORDERY (15*(SHEIGHT/200))
|
||
|
||
#define DXX_NEWMENU_VARIABLE m
|
||
#define DXX_ENUM_CHECK(S,OPT,V) OPT,
|
||
#define DXX_ENUM_SLIDER(S,OPT,V,MIN,MAX) OPT,
|
||
#define DXX_ENUM_SCALE_SLIDER(S,OPT,V,MIN,MAX,SCALE) OPT,
|
||
#define DXX_ENUM_MENU(S,OPT) OPT,
|
||
#define DXX_ENUM_TEXT(S,OPT) OPT,
|
||
#define DXX_ENUM_INPUT(S,OPT,MAX_TEXT_LEN) OPT,
|
||
#define DXX_COUNT_CHECK(S,OPT,V) +1
|
||
#define DXX_COUNT_SLIDER(S,OPT,V,MIN,MAX) +1
|
||
#define DXX_COUNT_SCALE_SLIDER(S,OPT,V,MIN,MAX,SCALE) +1
|
||
#define DXX_COUNT_MENU(S,OPT) +1
|
||
#define DXX_COUNT_TEXT(S,OPT) +1
|
||
#define DXX_COUNT_INPUT(S,OPT,MAX_TEXT_LEN) +1
|
||
#define DXX_ADD_CHECK(S,OPT,V) \
|
||
nm_set_item_checkbox(&((DXX_NEWMENU_VARIABLE)[(OPT)]), (S), (V));
|
||
#define DXX_ADD_SLIDER(S,OPT,V,MIN,MAX) \
|
||
nm_set_item_slider(&((DXX_NEWMENU_VARIABLE)[(OPT)]), (S), (V), (MIN), (MAX));
|
||
#define DXX_ADD_SCALE_SLIDER(S,OPT,V,MIN,MAX,SCALE) \
|
||
DXX_ADD_SLIDER((S),(OPT),(V) / (SCALE),(MIN),(MAX))
|
||
#define DXX_ADD_MENU(S,OPT) \
|
||
nm_set_item_menu(&((DXX_NEWMENU_VARIABLE)[(OPT)]), (S));
|
||
#define DXX_ADD_TEXT(S,OPT) \
|
||
nm_set_item_text(&((DXX_NEWMENU_VARIABLE)[(OPT)]), (S));
|
||
#define DXX_ADD_INPUT(S,OPT,MAX_TEXT_LEN) \
|
||
nm_set_item_input(&((DXX_NEWMENU_VARIABLE)[(OPT)]),MAX_TEXT_LEN,(S));
|
||
#define DXX_READ_CHECK(S,OPT,V) \
|
||
V = (DXX_NEWMENU_VARIABLE)[(OPT)].value;
|
||
#define DXX_READ_SLIDER(S,OPT,V,MIN,MAX) \
|
||
V = (DXX_NEWMENU_VARIABLE)[(OPT)].value;
|
||
#define DXX_READ_SCALE_SLIDER(S,OPT,V,MIN,MAX,SCALE) \
|
||
V = (DXX_NEWMENU_VARIABLE)[(OPT)].value * (SCALE);
|
||
#define DXX_READ_MENU(S,OPT) /* handled specially */
|
||
#define DXX_READ_TEXT(S,OPT) /* handled specially */
|
||
#define DXX_READ_INPUT(S,OPT,MAX_TEXT_LEN) /* handled specially */
|
||
|
||
#endif
|
||
|
||
#endif /* _NEWMENU_H */
|
||
|