All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.threerings.media.tile.tools.xml.XMLTileSetParser Maven / Gradle / Ivy

There is a newer version: 1.6.1
Show newest version
//
// Nenya library - tools for developing networked games
// Copyright (C) 2002-2012 Three Rings Design, Inc., All Rights Reserved
// https://github.com/threerings/nenya
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA

package com.threerings.media.tile.tools.xml;

import java.util.List;
import java.util.Map;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;

import org.xml.sax.SAXException;

import org.apache.commons.digester.Digester;

import com.google.common.collect.Lists;

import com.samskivert.util.ConfigUtil;
import com.samskivert.xml.ValidatedSetNextRule;

import com.threerings.media.tile.TileSet;

import static com.threerings.media.Log.log;

/**
 * Parse an XML tileset description file and construct tileset objects for
 * each valid description.  Does not currently perform validation on the
 * input XML stream, though the parsing code assumes the XML document is
 * well-formed.
 */
public class XMLTileSetParser
{
    /**
     * Constructs an xml tile set parser.
     */
    public XMLTileSetParser ()
    {
        // create our digester
        _digester = new Digester();
    }

    /**
     * Adds a ruleset to be used when parsing tiles. This should be an
     * instance of a class derived from {@link TileSetRuleSet}. The prefix
     * will be used to configure the ruleset so that it matches elements
     * at a particular point in the XML hierarchy. For example:
     *
     * 
     * _parser.addRuleSet("tilesets", new UniformTileSetRuleSet());
     * 
*/ public void addRuleSet (String prefix, TileSetRuleSet ruleset) { // configure the ruleset with the appropriate prefix ruleset.setPrefix(prefix); // and have it set itself up with the digester _digester.addRuleSet(ruleset); // add a set next rule which will put tilesets with this prefix // into the array list that'll be on the top of the stack _digester.addRule(ruleset.getPath(), new ValidatedSetNextRule("add", Object.class, ruleset)); } /** * Loads all of the tilesets specified in the supplied XML tileset * description file and places them into the supplied map indexed * by tileset name. This method is not reentrant, so don't go calling * it from multiple threads. * * @param path a path, relative to the classpath, at which the tileset * definition file can be found. * @param tilesets the map into which the tilesets will be placed, * indexed by tileset name. */ public void loadTileSets (String path, Map tilesets) throws IOException { // get an input stream for this XML file InputStream is = ConfigUtil.getStream(path); if (is == null) { String errmsg = "Can't load tileset description file from " + "classpath [path=" + path + "]."; throw new FileNotFoundException(errmsg); } // load up the tilesets loadTileSets(is, tilesets); } /** * Loads all of the tilesets specified in the supplied XML tileset * description file and places them into the supplied map indexed * by tileset name. This method is not reentrant, so don't go calling * it from multiple threads. * * @param file the file in which the tileset definition file can be * found. * @param tilesets the map into which the tilesets will be placed, * indexed by tileset name. */ public void loadTileSets (File file, Map tilesets) throws IOException { // load up the tilesets loadTileSets(new FileInputStream(file), tilesets); } /** * Loads all of the tilesets specified in the supplied XML tileset * description file and places them into the supplied map indexed * by tileset name. This method is not reentrant, so don't go calling * it from multiple threads. * * @param source an input stream from which the tileset definition * file can be read. * @param tilesets the map into which the tilesets will be placed, * indexed by tileset name. */ public void loadTileSets (InputStream source, Map tilesets) throws IOException { // stick an array list on the top of the stack for collecting // parsed tilesets List setlist = Lists.newArrayList(); _digester.push(setlist); // now fire up the digester to parse the stream try { _digester.parse(source); } catch (SAXException saxe) { log.warning("Exception parsing tile set descriptions.", saxe); } // stick the tilesets from the list into the hashtable for (int ii = 0; ii < setlist.size(); ii++) { TileSet set = setlist.get(ii); if (set.getName() == null) { log.warning("Tileset did not receive name during " + "parsing process [set=" + set + "]."); } else { tilesets.put(set.getName(), set); } } // and clear out the list for next time setlist.clear(); } /** Our XML digester. */ protected Digester _digester; }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy