Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

Writing Your Own RTF Converter

, 1 Aug 2013
An article on how to write a custom RTF parser and converter.
rtfconverter_sourcecode.zip
RtfConverter_SourceCode
bin
Debug
Release
Itenso.Rtf.Converter.Html.dll
Itenso.Rtf.Converter.Xml.dll
Itenso.Rtf.Interpreter.dll
Itenso.Rtf.Parser.dll
Itenso.Sys.dll
log4net.dll
nunit-console-runner.dll
nunit.core.dll
nunit.framework.dll
nunit.util.dll
Rtf2Html.exe
Rtf2Raw.exe
Rtf2Xml.exe
RtfInterpreterTests.exe
RtfParserTests.exe
RtfWindows.exe
RtfWinForms.exe
Converter
Html
Properties
Xml
Properties
docu
Word2007RTFSpec9.pdf
ext
log4net.dll
nunit-console-runner.dll
nunit.core.dll
nunit.framework.dll
nunit.util.dll
Interpreter
Converter
Image
Text
Interpreter
Model
Properties
Support
InterpreterTests
Properties
RtfInterpreterTest
RtfInterpreterTest_0.rtf
RtfInterpreterTest_1.rtf
RtfInterpreterTest_10.rtf
RtfInterpreterTest_11.rtf
RtfInterpreterTest_12.rtf
RtfInterpreterTest_13.rtf
RtfInterpreterTest_14.rtf
RtfInterpreterTest_15.rtf
RtfInterpreterTest_16.rtf
RtfInterpreterTest_17.rtf
RtfInterpreterTest_18.rtf
RtfInterpreterTest_19.rtf
RtfInterpreterTest_2.rtf
RtfInterpreterTest_20.rtf
RtfInterpreterTest_21.rtf
RtfInterpreterTest_22.rtf
RtfInterpreterTest_23.rtf
RtfInterpreterTest_3.rtf
RtfInterpreterTest_4.rtf
RtfInterpreterTest_4.rtf.jpg
RtfInterpreterTest_4.rtf.jpg.hex
RtfInterpreterTest_5.rtf
RtfInterpreterTest_5.rtf.png
RtfInterpreterTest_5.rtf.png.hex
RtfInterpreterTest_6.rtf
RtfInterpreterTest_6.rtf.wmf
RtfInterpreterTest_6.rtf.wmf.hex
RtfInterpreterTest_7.rtf
RtfInterpreterTest_7.rtf.emf
RtfInterpreterTest_7.rtf.emf.hex
RtfInterpreterTest_8.rtf
RtfInterpreterTest_8.rtf.wmf
RtfInterpreterTest_8.rtf.wmf.hex
RtfInterpreterTest_9.rtf
RtfInterpreterTest_fail_0.rtf
RtfInterpreterTest_fail_1.rtf
RtfInterpreterTest_fail_2.rtf
RtfInterpreterTest_fail_3.rtf
RtfInterpreterTest_fail_4.rtf
keys
ItensoRtfConverter.snk
Parser
Model
Parser
Properties
Support
ParserTests
Properties
RtfParserTest
minimal.rtf
RtfParserTest_0.rtf
RtfParserTest_1.rtf
RtfParserTest_2.rtf
RtfParserTest_3.rtf
RtfParserTest_4.rtf
RtfParserTest_5.rtf
RtfParserTest_6.rtf
RtfParserTest_7.rtf
RtfParserTest_8.rtf
RtfParserTest_fail_0.rtf
RtfParserTest_fail_1.rtf
RtfParserTest_fail_2.rtf
RtfParserTest_fail_3.rtf
RtfParserTest_fail_4.rtf
RtfParserTest_fail_5.rtf
RtfParserTest_fail_6.rtf
Rtf2Html
Properties
Rtf2Raw
Properties
Rtf2Xml
Properties
RtfWindows
Properties
RtfWinForms
DefaultText.rtf
Properties
Sys
Application
Collection
Logging
Properties
Test
RtfConverter_v1.7.0.zip
Rtf2Xml
Properties
bin
Release
Itenso.Rtf.Converter.Html.dll
Itenso.Rtf.Converter.Xml.dll
Itenso.Rtf.Interpreter.dll
Itenso.Rtf.Parser.dll
Itenso.Sys.dll
log4net.dll
nunit-console-runner.dll
nunit.core.dll
nunit.framework.dll
nunit.util.dll
Rtf2Html.exe
Rtf2Raw.exe
Rtf2Xml.exe
RtfInterpreterTests.exe
RtfParserTests.exe
RtfWindows.exe
RtfWinForms.exe
Converter
Html
Properties
Xml
Properties
docu
Word2007RTFSpec9.pdf
ext
log4net.dll
nunit-console-runner.dll
nunit.core.dll
nunit.framework.dll
nunit.util.dll
Interpreter
Converter
Image
Text
Interpreter
Model
Properties
Support
InterpreterTests
Properties
RtfInterpreterTest
RtfInterpreterTest_0.rtf
RtfInterpreterTest_1.rtf
RtfInterpreterTest_10.rtf
RtfInterpreterTest_11.rtf
RtfInterpreterTest_12.rtf
RtfInterpreterTest_13.rtf
RtfInterpreterTest_14.rtf
RtfInterpreterTest_15.rtf
RtfInterpreterTest_16.rtf
RtfInterpreterTest_17.rtf
RtfInterpreterTest_18.rtf
RtfInterpreterTest_19.rtf
RtfInterpreterTest_2.rtf
RtfInterpreterTest_20.rtf
RtfInterpreterTest_21.rtf
RtfInterpreterTest_22.rtf
RtfInterpreterTest_23.rtf
RtfInterpreterTest_3.rtf
RtfInterpreterTest_4.rtf
RtfInterpreterTest_4.rtf.jpg
RtfInterpreterTest_4.rtf.jpg.hex
RtfInterpreterTest_5.rtf
RtfInterpreterTest_5.rtf.png
RtfInterpreterTest_5.rtf.png.hex
RtfInterpreterTest_6.rtf
RtfInterpreterTest_6.rtf.wmf
RtfInterpreterTest_6.rtf.wmf.hex
RtfInterpreterTest_7.rtf
RtfInterpreterTest_7.rtf.emf
RtfInterpreterTest_7.rtf.emf.hex
RtfInterpreterTest_8.rtf
RtfInterpreterTest_8.rtf.wmf
RtfInterpreterTest_8.rtf.wmf.hex
RtfInterpreterTest_9.rtf
RtfInterpreterTest_fail_0.rtf
RtfInterpreterTest_fail_1.rtf
RtfInterpreterTest_fail_2.rtf
RtfInterpreterTest_fail_3.rtf
RtfInterpreterTest_fail_4.rtf
keys
ItensoRtfConverter.snk
Parser
Model
Parser
Properties
Support
ParserTests
Properties
RtfParserTest
minimal.rtf
RtfParserTest_0.rtf
RtfParserTest_1.rtf
RtfParserTest_2.rtf
RtfParserTest_3.rtf
RtfParserTest_4.rtf
RtfParserTest_5.rtf
RtfParserTest_6.rtf
RtfParserTest_7.rtf
RtfParserTest_8.rtf
RtfParserTest_fail_0.rtf
RtfParserTest_fail_1.rtf
RtfParserTest_fail_2.rtf
RtfParserTest_fail_3.rtf
RtfParserTest_fail_4.rtf
RtfParserTest_fail_5.rtf
RtfParserTest_fail_6.rtf
Rtf2Html
Properties
Rtf2Raw
Properties
RtfWindows
Properties
RtfWinForms
DefaultText.rtf
Properties
Sys
Application
Collection
Logging
Properties
Test
// -- FILE ------------------------------------------------------------------
// name       : TestUnitBase.cs
// project    : System Framelet
// created    : Leon Poyyayil - 2008.05.20
// language   : c#
// environment: .NET 2.0
// copyright  : (c) 2004-2010 by Itenso GmbH, Switzerland
// --------------------------------------------------------------------------
using System;
using System.IO;
using System.Reflection;
using Itenso.Sys.Logging;
using NUnit.Framework;

namespace Itenso.Sys.Test
{

	// ------------------------------------------------------------------------
	public abstract class TestUnitBase
	{

		// ----------------------------------------------------------------------
		[SetUp]
		public void Initialize()
		{
		} // Initialize

		// ----------------------------------------------------------------------
		[TearDown]
		public void Cleanup()
		{
		} // Cleanup

		// ----------------------------------------------------------------------
		public static void AssertEqualLines( string msgPrefix, string expected, string actual )
		{
			if ( !expected.Equals( actual ) )
			{
				AssertEqualLines( msgPrefix, new StringReader( expected ), new StringReader( actual ) );
			}
		} // AssertEqualLines

		// ----------------------------------------------------------------------
		public static void AssertEqualLines( string msgPrefix, TextReader expectedReader, TextReader actualReader )
		{
			int lineNumber = 1;
			string expectedLine = expectedReader.ReadLine();
			string actualLine = actualReader.ReadLine();
			string msg = msgPrefix + " differs from expected at line ";
			while ( expectedLine != null && actualLine != null )
			{
				if ( !expectedLine.Equals( actualLine ) )
				{
					Assert.AreEqual( expectedLine, actualLine, msg + lineNumber );
				}
				lineNumber++;
				expectedLine = expectedReader.ReadLine();
				actualLine = actualReader.ReadLine();
			}
			if ( expectedLine != null || actualLine != null )
			{
				Assert.AreEqual( expectedLine, actualLine, msg + lineNumber );
			}
		} // AssertEqualLines

		// ----------------------------------------------------------------------
		protected void IterateResourceTestCases( string kind, string ext, bool expectFailures )
		{
			int count = 0;
			string testCaseName = BuildTestResourceName( kind, count, false, ext );
			Stream testResStream = GetTestResource( testCaseName );
			while ( testResStream != null )
			{
				count++;
				logger.Debug( "" );
				logger.Debug( "==================================================================" );
				logger.Info( "Test case (valid): " + testCaseName );
				DoTest( kind, testResStream, testCaseName );
				testCaseName = BuildTestResourceName( kind, count, false, ext );
				testResStream = GetTestResource( testCaseName );
			}
			Assert.AreNotEqual( 0, count, "no valid test cases found: " + testCaseName );

			if ( expectFailures )
			{
				count = 0;
				testCaseName = BuildTestResourceName( kind, count, true, ext );
				testResStream = GetTestResource( testCaseName );
				while ( testResStream != null )
				{
					count++;
					bool assertionException = false;
					try
					{
						logger.Debug( "" );
						logger.Debug( "==================================================================" );
						logger.Info( "Test case (invalid): " + testCaseName );
						DoTest( kind, testResStream, testCaseName );
						assertionException = true;
						Assert.Fail( "invalid test case not recognized as invalid: " + testCaseName );
					}
					catch ( Exception )
					{
						// expected, but if it is an assertion exception we need to re-throw it
						if ( assertionException )
						{
							throw;
						}
					}
					testCaseName = BuildTestResourceName( kind, count, true, ext );
					testResStream = GetTestResource( testCaseName );
				}
				Assert.AreNotEqual( 0, count, "no invalid test cases found: " + testCaseName );
			}
		} // IterateResourceTestCases

		// ----------------------------------------------------------------------
		protected virtual void DoTest( string kind, Stream testRes, string testCaseName )
		{
			Assert.Fail( GetType().FullName + " must override method DoTest() when calling IterateTestCases()" );
		} // DoTest

		// ----------------------------------------------------------------------
		protected string BuildTestResourceName( string kind, int pos, bool fail, string ext )
		{
			return GetType().Name + kind + "_" + (fail ? "fail_" : "") + pos + "." + ext;
		} // BuildTestResourceName

		// ----------------------------------------------------------------------
		protected Stream GetTestResource( string filename )
		{
			return GetResourceAsStream( GetType().Name + "/" + filename );
		} // GetTestResource

		// ----------------------------------------------------------------------
		/// <summary>
		/// Opens a stream to the given embedded resource in the test assembly. Fails if the
		/// given test resource cannot be located in the assembly.
		/// </summary>
		/// <param name="name">the name of the embedded resource without assembly prefix</param>
		/// <returns>an open stream to the desired embedded resource</returns>
		protected Stream GetResourceAsStream( string name )
		{
			Type type = GetType();
			Assembly assembly = type.Assembly;
			string namespaceName = type.Namespace;
			string fullName = namespaceName + "." + name.Replace( '\\', '.' ).Replace( '/', '.' );
			return assembly.GetManifestResourceStream( fullName );
		} // GetResourceAsStream

		// ----------------------------------------------------------------------
		// members
		private static readonly ILogger logger = Logger.GetLogger( typeof( TestUnitBase ) );

	} // class TestUnitBase

} // namespace Itenso.Rtf.Test
// -- EOF -------------------------------------------------------------------

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Author

Jani Giannoudis
Software Developer (Senior)
Switzerland Switzerland
Jani is Co-founder of Meerazo.com, a free service which allows to share resources like locations, things, persons and their services in a cooperating group of people.

| Advertise | Privacy | Mobile
Web02 | 2.8.140821.2 | Last Updated 1 Aug 2013
Article Copyright 2008 by Jani Giannoudis
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid