12 posts
string expected, got nil
Posted 24 July 2013 - 07:01 PM
Apparently the mods didn't like my epically legit rednet hacking concept. D:…
I've decided that they won't like anything similar so I decided to make something else.
Settings File API
Don't you have a program but you can't store any important settings or preferences or other necessary storage stuffies? This API is here to help!!! Please read the below stuff for information about how to set up a settings file and how to use the API. Please post any issues you find with the API and any suggestions for features I should add. I would also love if someone made an editor for settings files. Thanks for checking it out!
Pastebin: FTmDPGRF
On your computer, type: "pastebin get FtmDPGRF settings" or whatever you are supposed to type and it will appear for you.
This API is designed to handle a new type of file I created called a settings file. (Inspired by .ini files)
These are very user friendly and also computer-friendly with this new API. Here's how one would look:
Here are the features of a settings file:
Name-Value Data storage: Your information can be stored as a value, and can be referenced by a name.
For example:
This simple method contains several features that will make you happier.
Automatic white space removal: names and values are trimmed of leading and ending whitespace. For example:
Explicit String Declaration: You can even declare a string manually in a value and force it to be treated as a string using quotation marks. Anything within quotation marks won't be changed by the parser, and will be given to you directly. For example:
Comments: Anything after a semicolon is considered a comment. Pretty simple, huh?
Sections: You can declare a section by placing it's name in square brackets like this:
That's how a settings file looks. Here's how to use the simple API:
filepath: The file path of the settings file
returns: a settings file handle from the opened file
name: Name of the section to add.
key: Name of value to retrieve
returns: Value if exists, else nil
section: Section containing the sectioned value
key: Name of the value
returns: Value if exists, else nil
key: Name of the value
value: Value to set it to
section: Section containing the sectioned value
key: Name of the value
value: Value to set it to
path: Path to save the settings file to.
Here is an example of how to open the example file at the very beginning of this document, get the value of "printer_side", modify that value, insert a section, insert a sectioned value, and save the file.
I've decided that they won't like anything similar so I decided to make something else.
Settings File API
Don't you have a program but you can't store any important settings or preferences or other necessary storage stuffies? This API is here to help!!! Please read the below stuff for information about how to set up a settings file and how to use the API. Please post any issues you find with the API and any suggestions for features I should add. I would also love if someone made an editor for settings files. Thanks for checking it out!
Pastebin: FTmDPGRF
On your computer, type: "pastebin get FtmDPGRF settings" or whatever you are supposed to type and it will appear for you.
This API is designed to handle a new type of file I created called a settings file. (Inspired by .ini files)
These are very user friendly and also computer-friendly with this new API. Here's how one would look:
; #Text editor settings file
printer_side: top
debug_mode: 0
last find = " coroutine.r"
[Colors]
text_background: 19
text_foreground: 18
window_border_background: 15
window_border foreground: 10
color_1: 8
[CustomShortcuts]
save = CtrlShiftS
print = CtrlShiftP
help = CtrlH
Here are the features of a settings file:
Name-Value Data storage: Your information can be stored as a value, and can be referenced by a name.
For example:
printer_side = top
This simple method contains several features that will make you happier.
Automatic white space removal: names and values are trimmed of leading and ending whitespace. For example:
some key = hehehehe
some key=hehehehe
printer side: top
printer side = top
Explicit String Declaration: You can even declare a string manually in a value and force it to be treated as a string using quotation marks. Anything within quotation marks won't be changed by the parser, and will be given to you directly. For example:
number_of_cows = "10"
number_of_cows = 10
text = " stuff"
text = stuff
Comments: Anything after a semicolon is considered a comment. Pretty simple, huh?
Sections: You can declare a section by placing it's name in square brackets like this:
[section name]
name = value
othername = somevalue
That's how a settings file looks. Here's how to use the simple API:
settings.openSettingsFile(filepath)
filepath: The file path of the settings file
returns: a settings file handle from the opened file
settingsfilehandle.addSection(name)
name: Name of the section to add.
settingsfilehandle.getValue(key)
key: Name of value to retrieve
returns: Value if exists, else nil
settingsfilehandle.getSectionedValue(section, key)
section: Section containing the sectioned value
key: Name of the value
returns: Value if exists, else nil
settingsfilehandle.setValue(key, value)
key: Name of the value
value: Value to set it to
settingsfilehandle.setSectionedValue(section, key, value)
section: Section containing the sectioned value
key: Name of the value
value: Value to set it to
settingsfilehandle.save(path)
path: Path to save the settings file to.
Here is an example of how to open the example file at the very beginning of this document, get the value of "printer_side", modify that value, insert a section, insert a sectioned value, and save the file.
os.loadAPI("settings")
local settingsfile = settings.openSettingsFile("examplefile")
print(settingsfile.getValue("printer_side"))
settingsfile.setValue("printer_side", "left")
settingsfile.addSection("Personal Information")
settingsfile.setSectionedValue("Personal Information", "Name", "Joe Shmoe")
settingsfile.save("examplefile")
os.unloadAPI("settings")
