/***********************************************************************************
Snes9x - Portable Super Nintendo Entertainment System (TM) emulator.
(c) Copyright 1996 - 2002 Gary Henderson (gary.henderson@ntlworld.com),
Jerremy Koot (jkoot@snes9x.com)
(c) Copyright 2002 - 2004 Matthew Kendora
(c) Copyright 2002 - 2005 Peter Bortas (peter@bortas.org)
(c) Copyright 2004 - 2005 Joel Yliluoma (http://iki.fi/bisqwit/)
(c) Copyright 2001 - 2006 John Weidman (jweidman@slip.net)
(c) Copyright 2002 - 2006 funkyass (funkyass@spam.shaw.ca),
Kris Bleakley (codeviolation@hotmail.com)
(c) Copyright 2002 - 2010 Brad Jorsch (anomie@users.sourceforge.net),
Nach (n-a-c-h@users.sourceforge.net),
(c) Copyright 2002 - 2011 zones (kasumitokoduck@yahoo.com)
(c) Copyright 2006 - 2007 nitsuja
(c) Copyright 2009 - 2018 BearOso,
OV2
(c) Copyright 2017 qwertymodo
(c) Copyright 2011 - 2017 Hans-Kristian Arntzen,
Daniel De Matteis
(Under no circumstances will commercial rights be given)
BS-X C emulator code
(c) Copyright 2005 - 2006 Dreamer Nom,
zones
C4 x86 assembler and some C emulation code
(c) Copyright 2000 - 2003 _Demo_ (_demo_@zsnes.com),
Nach,
zsKnight (zsknight@zsnes.com)
C4 C++ code
(c) Copyright 2003 - 2006 Brad Jorsch,
Nach
DSP-1 emulator code
(c) Copyright 1998 - 2006 _Demo_,
Andreas Naive (andreasnaive@gmail.com),
Gary Henderson,
Ivar (ivar@snes9x.com),
John Weidman,
Kris Bleakley,
Matthew Kendora,
Nach,
neviksti (neviksti@hotmail.com)
DSP-2 emulator code
(c) Copyright 2003 John Weidman,
Kris Bleakley,
Lord Nightmare (lord_nightmare@users.sourceforge.net),
Matthew Kendora,
neviksti
DSP-3 emulator code
(c) Copyright 2003 - 2006 John Weidman,
Kris Bleakley,
Lancer,
z80 gaiden
DSP-4 emulator code
(c) Copyright 2004 - 2006 Dreamer Nom,
John Weidman,
Kris Bleakley,
Nach,
z80 gaiden
OBC1 emulator code
(c) Copyright 2001 - 2004 zsKnight,
pagefault (pagefault@zsnes.com),
Kris Bleakley
Ported from x86 assembler to C by sanmaiwashi
SPC7110 and RTC C++ emulator code used in 1.39-1.51
(c) Copyright 2002 Matthew Kendora with research by
zsKnight,
John Weidman,
Dark Force
SPC7110 and RTC C++ emulator code used in 1.52+
(c) Copyright 2009 byuu,
neviksti
S-DD1 C emulator code
(c) Copyright 2003 Brad Jorsch with research by
Andreas Naive,
John Weidman
S-RTC C emulator code
(c) Copyright 2001 - 2006 byuu,
John Weidman
ST010 C++ emulator code
(c) Copyright 2003 Feather,
John Weidman,
Kris Bleakley,
Matthew Kendora
Super FX x86 assembler emulator code
(c) Copyright 1998 - 2003 _Demo_,
pagefault,
zsKnight
Super FX C emulator code
(c) Copyright 1997 - 1999 Ivar,
Gary Henderson,
John Weidman
Sound emulator code used in 1.5-1.51
(c) Copyright 1998 - 2003 Brad Martin
(c) Copyright 1998 - 2006 Charles Bilyue'
Sound emulator code used in 1.52+
(c) Copyright 2004 - 2007 Shay Green (gblargg@gmail.com)
S-SMP emulator code used in 1.54+
(c) Copyright 2016 byuu
SH assembler code partly based on x86 assembler code
(c) Copyright 2002 - 2004 Marcus Comstedt (marcus@mc.pp.se)
2xSaI filter
(c) Copyright 1999 - 2001 Derek Liauw Kie Fa
HQ2x, HQ3x, HQ4x filters
(c) Copyright 2003 Maxim Stepin (maxim@hiend3d.com)
NTSC filter
(c) Copyright 2006 - 2007 Shay Green
GTK+ GUI code
(c) Copyright 2004 - 2018 BearOso
Win32 GUI code
(c) Copyright 2003 - 2006 blip,
funkyass,
Matthew Kendora,
Nach,
nitsuja
(c) Copyright 2009 - 2018 OV2
Mac OS GUI code
(c) Copyright 1998 - 2001 John Stiles
(c) Copyright 2001 - 2011 zones
Libretro port
(c) Copyright 2011 - 2017 Hans-Kristian Arntzen,
Daniel De Matteis
(Under no circumstances will commercial rights be given)
Specific ports contains the works of other authors. See headers in
individual files.
Snes9x homepage: http://www.snes9x.com/
Permission to use, copy, modify and/or distribute Snes9x in both binary
and source form, for non-commercial purposes, is hereby granted without
fee, providing that this license information and copyright notice appear
with all copies and any derived work.
This software is provided 'as-is', without any express or implied
warranty. In no event shall the authors be held liable for any damages
arising from the use of this software or it's derivatives.
Snes9x is freeware for PERSONAL USE only. Commercial users should
seek permission of the copyright holders first. Commercial use includes,
but is not limited to, charging money for Snes9x or software derived from
Snes9x, including Snes9x or derivatives in commercial game bundles, and/or
using Snes9x as a promotion for your commercial product.
The copyright holders request that bug fixes and improvements to the code
should be forwarded to them so everyone can benefit from the modifications
in future versions.
Super NES and Super Nintendo Entertainment System are trademarks of
Nintendo Co., Limited and its subsidiary companies.
***********************************************************************************/
#ifndef _CONFIG_H_
#define _CONFIG_H_
#include <set>
#include <map>
#include <vector>
#include <string>
#ifdef UNZIP_SUPPORT
# ifdef SYSTEM_ZIP
# include <minizip/unzip.h>
# else
# include "unzip/unzip.h"
# endif
#endif
#include "snes9x.h"
#ifndef MAX
# define MAX(a,b) ((a) > (b)? (a) : (b))
# define MIN(a,b) ((a) < (b)? (a) : (b))
#endif
class ConfigFile {
public:
ConfigFile(void);
void Clear(void);
// return false on failure
bool LoadFile(const char *filename);
void LoadFile(Stream *r, const char *name=NULL);
// return false if key does not exist or is empty
bool Exists(const char *key);
// return the value / default
std::string GetString(const char *key, std::string def);
char *GetString(const char *key, char *out, uint32 outlen); // return NULL if it doesn't exist, out not affected
const char *GetString(const char *key, const char *def=NULL); // NOTE: returned pointer becomes invalid when key is deleted/modified, or the ConfigFile is Clear()ed or deleted.
char *GetStringDup(const char *key, const char *def=NULL); // Much like "strdup(GetString(key, def))"
int32 GetInt(const char *key, int32 def=-1, bool *bad=NULL);
uint32 GetUInt(const char *key, uint32 def=0, int base=0, bool *bad=NULL); // base = 0, 8, 10, or 16
bool GetBool(const char *key, bool def=false, bool *bad=NULL);
const char* GetComment(const char *key); // NOTE: returned pointer becomes invalid when key is deleted/modified, or the ConfigFile is Clear()ed or deleted.
// return true if the key existed prior to setting
bool SetString(const char *key, std::string val, const char *comment="");
bool SetInt(const char *key, int32 val, const char *comment="");
bool SetUInt(const char *key, uint32 val, int base=10, const char *comment=""); // base = 8, 10, or 16
bool SetBool(const char *key, bool val, const char *true_val="TRUE", const char *false_val="FALSE", const char *comment="");
bool DeleteKey(const char *key);
// Operation on entire sections
bool DeleteSection(const char *section);
typedef std::vector<std::pair<std::string,std::string> > secvec_t;
secvec_t GetSection(const char *section);
int GetSectionSize(const std::string section);
// Clears all key-value pairs that didn't receive a Set command, or a Get command with autoAdd on
void ClearUnused(void);
// Clears all stored line numbers
void ClearLines(void);
bool SaveTo(const char *filename);
static void SetDefaultAutoAdd(bool autoAdd);
static void SetNiceAlignment(bool align);
static void SetShowComments(bool show);
static void SetAlphaSort(bool sort);
static void SetTimeSort(bool sort);
private:
std::string Get(const char *key);
bool Has(const char *key);
class ConfigEntry {
protected:
int line;
std::string section;
std::string key;
std::string val;
std::string comment;
mutable bool used;
struct section_then_key_less {
bool operator()(const ConfigEntry &a, const ConfigEntry &b);
};
struct key_less {
bool operator()(const ConfigEntry &a, const ConfigEntry &b) const{
if(a.section!=b.section) return a.section<b.section;
return a.key<b.key;
}
};
struct line_less {
bool operator()(const ConfigEntry &a, const ConfigEntry &b){
if(a.line==b.line) return (b.val.empty() && !a.val.empty()) || a.key<b.key;
if(b.line<0) return true;
if(a.line<0) return false;
return a.line<b.line;
}
};
static void trim(std::string &s){
int i;
i=s.find_first_not_of(" \f\n\r\t\v");
if(i==-1){
s.clear();
return;
}
if(i>0) s.erase(0, i); // erase leading whitespace
i=s.find_last_not_of(" \f\n\r\t\v");
if(i!=-1) s.erase(i+1); // erase trailing whitespace
return;
}
// trims comments and leading/trailing whitespace from s, and returns any trimmed comments
// make sure not to call this more than once on the same string
static std::string trimCommented(std::string &s){
std::string cmt;
int i;
i=s.find_first_not_of(" \f\n\r\t\v");
if(i==-1){
s.clear();
return cmt;
}
if(i>0) s.erase(0, i); // erase leading whitespace
int off=0;
for(;;){
i=s.find('#',off); // find trailing comment
if(i>=0)
{
if((int)s.length()>i+1 && s.at(i+1) == '#') {
s.erase(i,1); // ignore ## and change to #
off = i+1;
continue;
} else {
int j=s.find_first_not_of(" \f\n\r\t\v",i+1);
if(j!=-1) cmt = s.substr(j); // store
s.erase(i); // erase trailing comment
}
}
break;
}
i=s.find_last_not_of(" \f\n\r\t\v");
if(i!=-1) s.erase(i+1); // erase trailing whitespace
return cmt;
}
public:
ConfigEntry(int l, const std::string &s, const std::string &k, const std::string &v) :
line(l), section(s), key(k), val(v) {
trim(section);
trim(key);
used=false;
}
void parse_key(const std::string &k){
int i=k.find("::");
if(i==-1){
section="Uncategorized"; key=k;
} else {
section=k.substr(0,i); key=k.substr(i+2);
}
trim(section);
trim(key);
used=false;
}
ConfigEntry(const std::string k){
parse_key(k);
}
ConfigEntry(const std::string k, const std::string &v) : line(-1), val(v) {
parse_key(k);
}
friend class ConfigFile;
friend struct key_less;
friend struct line_less;
};
class SectionSizes {
protected:
std::map<std::string,uint32> sections;
public:
uint32 GetSectionSize(const std::string section) {
uint32 count=0;
uint32 seclen;
std::map<std::string,uint32>::iterator it;
for(it=sections.begin(); it!=sections.end(); it++) {
seclen = MIN(section.size(),it->first.size());
if(it->first==section || !section.compare(0,seclen,it->first,0,seclen)) count+=it->second;
}
return count;
}
void IncreaseSectionSize(const std::string section) {
std::map<std::string,uint32>::iterator it=sections.find(section);
if(it!=sections.end())
it->second++;
else
sections.insert(std::pair<std::string,uint32>(section,1));
}
void DecreaseSectionSize(const std::string section) {
std::map<std::string,uint32>::iterator it=sections.find(section);
if(it!=sections.end())
it->second--;
}
void ClearSections() {
sections.clear();
}
void DeleteSection(const std::string section) {
sections.erase(section);
}
};
std::set<ConfigEntry, ConfigEntry::key_less> data;
SectionSizes sectionSizes;
int linectr;
static bool defaultAutoAdd;
static bool niceAlignment;
static bool showComments;
static bool alphaSort;
static bool timeSort;
};
/* Config file format:
*
* Comments are any lines whose first non-whitespace character is ';' or '#'.
* Note that comments can also follow a value, on the same line.
* To intentionally have a '#' character in the value, use ##
*
* All parameters fall into sections. To name a section, the first
* non-whitespace character on the line will be '[', and the last will be ']'.
*
* Parameters are simple key=value pairs. Whitespace around the '=', and at the
* beginning or end of the line is ignored. Key names may not contain '=' nor
* begin with '[', however values can. If the last character of the value is
* '\', the next line (sans leading/trailing whitespace) is considered part of
* the value as well. Programmatically, the key "K" in section "S" is referred
* to as "S::K", much like C++ namespaces. For example:
* [Section1]
* # this is a comment
* foo = bar \
* baz\
* quux \
* ## this is not a comment! # this IS a comment
* means the value of "Section1::foo" is "bar bazquux # this is not a comment!"
*
* Parameters may be of several types:
* String - Bare characters. If the first and last characters are both '"',
* they are removed (so just double them if you really want quotes
* there)
* Int - A decimal number from -2147483648 to 2147483647
* UInt - A number in decimal, hex, or octal from 0 to 4294967295 (or
* 0xffffffff, or 037777777777)
* Bool - true/false, 0/1, on/off, yes/no
*
* Of course, the actual accepted values for a parameter may be further
* restricted ;)
*/
/* You must write this for your port */
void S9xParsePortConfig(ConfigFile &, int pass);
/* This may or may not be useful to you */
const char *S9xParseDisplayConfig(ConfigFile &, int pass);
#endif