RetroZilla/extensions/java/xpcom/interfaces/INIParser.java
2015-10-20 23:03:22 -04:00

245 lines
7.8 KiB
Java

/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Java XPCOM Bindings.
*
* The Initial Developer of the Original Code is
* IBM Corporation.
* Portions created by the Initial Developer are Copyright (C) 2005
* IBM Corporation. All Rights Reserved.
*
* Contributor(s):
* Javier Pedemonte (jhpedemonte@gmail.com)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
package org.mozilla.xpcom;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStreamReader;
import java.nio.charset.Charset;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Properties;
import java.util.StringTokenizer;
/**
* A simple parser for INI files.
*/
public class INIParser {
private HashMap mSections;
/**
* Creates a new <code>INIParser</code> instance from the INI file at the
* given path. <code>aCharset</code> specifies the character encoding of
* the file.
*
* @param aFilename path of INI file to parse
* @param aCharset character encoding of file
* @throws FileNotFoundException if <code>aFilename</code> does not exist.
* @throws IOException if there is a problem reading the given file.
*/
public INIParser(String aFilename, Charset aCharset)
throws FileNotFoundException, IOException {
initFromFile(new File(aFilename), aCharset);
}
/**
* Creates a new <code>INIParser</code> instance from the INI file at the
* given path, which is assumed to be in the <code>UTF-8</code> charset.
*
* @param aFilename path of INI file to parse
* @throws FileNotFoundException if <code>aFilename</code> does not exist.
* @throws IOException if there is a problem reading the given file.
*/
public INIParser(String aFilename) throws FileNotFoundException, IOException {
initFromFile(new File(aFilename), Charset.forName("UTF-8"));
}
/**
* Creates a new <code>INIParser</code> instance from the given file.
* <code>aCharset</code> specifies the character encoding of the file.
*
* @param aFile INI file to parse
* @param aCharset character encoding of file
* @throws FileNotFoundException if <code>aFile</code> does not exist.
* @throws IOException if there is a problem reading the given file.
*/
public INIParser(File aFile, Charset aCharset)
throws FileNotFoundException, IOException {
initFromFile(aFile, aCharset);
}
/**
* Creates a new <code>INIParser</code> instance from the given file,
* which is assumed to be in the <code>UTF-8</code> charset.
*
* @param aFile INI file to parse
* @throws FileNotFoundException if <code>aFile</code> does not exist.
* @throws IOException if there is a problem reading the given file.
*/
public INIParser(File aFile) throws FileNotFoundException, IOException {
initFromFile(aFile, Charset.forName("UTF-8"));
}
/**
* Parses given INI file.
*
* @param aFile INI file to parse
* @param aCharset character encoding of file
* @throws FileNotFoundException if <code>aFile</code> does not exist.
* @throws IOException if there is a problem reading the given file.
*/
private void initFromFile(File aFile, Charset aCharset)
throws FileNotFoundException, IOException {
FileInputStream fileStream = new FileInputStream(aFile);
InputStreamReader inStream = new InputStreamReader(fileStream, aCharset);
BufferedReader reader = new BufferedReader(inStream);
mSections = new HashMap();
String currSection = null;
String line;
while ((line = reader.readLine()) != null) {
// skip empty lines and comment lines
String trimmedLine = line.trim();
if (trimmedLine.length() == 0 || trimmedLine.startsWith("#")
|| trimmedLine.startsWith(";")) {
continue;
}
// Look for section headers (i.e. "[Section]").
if (line.startsWith("[")) {
/*
* We are looking for a well-formed "[Section]". If this header is
* malformed (i.e. "[Section" or "[Section]Moretext"), just skip it
* and go on to next well-formed section header.
*/
if (!trimmedLine.endsWith("]") ||
trimmedLine.indexOf("]") != (trimmedLine.length() - 1)) {
currSection = null;
continue;
}
// remove enclosing brackets
currSection = trimmedLine.substring(1, trimmedLine.length() - 1);
continue;
}
// If we haven't found a valid section header, continue to next line
if (currSection == null) {
continue;
}
StringTokenizer tok = new StringTokenizer(line, "=");
if (tok.countTokens() != 2) { // looking for value pairs
continue;
}
Properties props = (Properties) mSections.get(currSection);
if (props == null) {
props = new Properties();
mSections.put(currSection, props);
}
props.setProperty(tok.nextToken(), tok.nextToken());
}
reader.close();
}
/**
* Returns an iterator over the section names available in the INI file.
*
* @return an iterator over the section names
*/
public Iterator getSections() {
return mSections.keySet().iterator();
}
/**
* Returns an iterator over the keys available within a section.
*
* @param aSection section name whose keys are to be returned
* @return an iterator over section keys, or <code>null</code> if no
* such section exists
*/
public Iterator getKeys(String aSection) {
/*
* Simple wrapper class to convert Enumeration to Iterator
*/
class PropertiesIterator implements Iterator {
private Enumeration e;
public PropertiesIterator(Enumeration aEnum) {
e = aEnum;
}
public boolean hasNext() {
return e.hasMoreElements();
}
public Object next() {
return e.nextElement();
}
public void remove() {
return;
}
}
Properties props = (Properties) mSections.get(aSection);
if (props == null) {
return null;
}
return new PropertiesIterator(props.propertyNames());
}
/**
* Gets the string value for a particular section and key.
*
* @param aSection a section name
* @param aKey the key whose value is to be returned.
* @return string value of particular section and key
*/
public String getString(String aSection, String aKey) {
Properties props = (Properties) mSections.get(aSection);
if (props == null) {
return null;
}
return props.getProperty(aKey);
}
}