xml-region-analyzer's Introduction

XML Region Analyzer

A light and simple lexical analyzer for XML.

This project was created because I needed a simple way to add syntax highlighting in a stand-alone SWT application. Since there was no simple solution, I created one. Given a string representing a XML document, it finds regions and their positions.

Here is an example.

List<XmlRegion> regions = new XmlRegionAnalyzer().analyzeXml( yourXmlAsAString );
for( XmlRegion xr : regions ) {
   switch( xr.getXmlRegionType ()) {
   	case XmlRegionType.MARKUP: break;
   	case XmlRegionType.ATTRIBUTE: break;
   	case XmlRegionType.ATTRIBUTE_VALUE: break;
   	case XmlRegionType.MARKUP_VALUE: break;
   	case XmlRegionType.COMMENT: break;
   	case XmlRegionType.INSTRUCTION: break;
   	case XmlRegionType.CDATA: break;
   	case XmlRegionType.WHITESPACE: break;
   	default: break;
   }
   
   int regionLength = xr.getEnd() - xr.getStart();
   System.out.println( "Region Length:" + regionLength );
}

Using it

You can add this project in your Maven dependencies.

<dependency>
	<groupId>com.github.vincent-zurczak</groupId>
	<artifactId>xml-region-analyzer</artifactId>
	<version>1.0.0</version>
</dependency>

This project has no dependency towards other libraries.

Development

# Compile and package
mvn clean package

# Run the tests
mvn clean test

# Get code coverage (then check target/site/cobertura/)
mvn clean cobertura:cobertura

License

The source code is licensed under the terms of the Apache license v2.

xml-region-analyzer's People

Contributors

Stargazers

Watchers

xml-region-analyzer's Issues

Infinite Loop in analyzeInstruction

Infinite Loop in analyzeInstruction if XML has ""

this works for me:

boolean analyzeInstruction( String xml, List positions ) {

	boolean result = false;
	int newPos = this.offset;
	if( newPos < xml.length()
			&& xml.charAt( newPos ) == '<'
			&& ++ newPos < xml.length()
			&& xml.charAt( newPos ) == '?' ) {

		while( newPos > -1 && ++ newPos < xml.length() 
				&& xml.charAt( newPos ) != '>' )
			newPos = xml.indexOf( '?', newPos );

		if( newPos > -1 && xml.charAt( newPos ) == '>' ) {
			positions.add( new XmlRegion( XmlRegionType.INSTRUCTION, this.offset, newPos + 1 ));
			this.offset = newPos + 1;
			result = true;
		}
	}

	return result;
}

And thanks for sharing!!!