doxia-1.1.4/doxia-sink-api/src/main/java/ 0000755 0001750 0001750 00000000000 11632765560 020043 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765561 020633 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765560 022053 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765560 023161 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765560 024265 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/ 0000755 0001750 0001750 00000000000 11632765561 025232 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/Sink.java 0000644 0001750 0001750 00000117754 11331336337 027007 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.logging.LogEnabled;
/**
* A Sink consumes Doxia events to produce a resultant output format
* (eg Docbook, PDF, XHTML...).
*
* Doxia allows you to transform any supported input document format (ie for which a Parser exists)
* into any supported output document format (ie for which a Sink exists).
*
*
* A parser is responsible for reading an input document and emitting a sequence of Doxia events
* which can then be consumed by a Doxia Sink. Thus, you can parse any front- end format
* (eg APT, FML, Xdoc, ...) and have them all contribute to a final XHTML version of a web site.
* All documents being parsed result in a stream of Doxia events (eg paragraph, bold, italic,
* text,...), which are then fed into a XHTML Sink to produce a set of XHTML pages.
*
*
* A Sink is ultimately responsible for the final format and structure of the output document.
* For example, you can take a collection of APT documents, let a Parser emit a series of Doxia
* events and have that be fed into a Sink to produce a single PDF, a book, a site, or a
* Word document. The Sink is fully responsible for the final output.
*
*
* You can easily integrate any custom (XML, Wiki,...) format by creating a Doxia Parser which
* reads your input document and produces a proper sequence of Doxia events.
* Those can then be fed into an arbitrary Sink to produce any desired final output.
*
*
* Note: All implemented sink should use UTF-8 as encoding.
*
*
* @since 1.0-alpha-6
* @author Jason van Zyl
* @author Vincent Siveton
* @author ltheussl
* @version $Id: Sink.java 905077 2010-01-31 17:24:47Z hboutemy $
*/
public interface Sink
extends LogEnabled
{
/** The Plexus Sink Role. */
String ROLE = Sink.class.getName();
/**
* A numbering to handle a number list.
* @see #numberedList(int,SinkEventAttributes)
*/
int NUMBERING_DECIMAL = 0;
/**
* A numbering to handle a lower alpha list.
* @see #numberedList(int,SinkEventAttributes)
*/
int NUMBERING_LOWER_ALPHA = 1;
/**
* A numbering to handle a upper alpha list.
* @see #numberedList(int,SinkEventAttributes)
*/
int NUMBERING_UPPER_ALPHA = 2;
/**
* A numbering to handle a lower roman list.
* @see #numberedList(int,SinkEventAttributes)
*/
int NUMBERING_LOWER_ROMAN = 3;
/**
* A numbering to handle a upper roman list.
* @see #numberedList(int,SinkEventAttributes)
*/
int NUMBERING_UPPER_ROMAN = 4;
/**
* A level 1 section (section).
* @see #section(int,SinkEventAttributes)
*/
int SECTION_LEVEL_1 = 1;
/**
* A level 2 section (subsection).
* @see #section(int,SinkEventAttributes)
*/
int SECTION_LEVEL_2 = 2;
/**
* A level 3 section (sub-subsection).
* @see #section(int,SinkEventAttributes)
*/
int SECTION_LEVEL_3 = 3;
/**
* A level 4 section (sub-sub-subsection).
* @see #section(int,SinkEventAttributes)
*/
int SECTION_LEVEL_4 = 4;
/**
* A level 5 section (sub-sub-sub-subsection).
* @see #section(int,SinkEventAttributes)
*/
int SECTION_LEVEL_5 = 5;
/**
* Center alignment for table cells.
* @see #tableRows(int[], boolean)
*/
int JUSTIFY_CENTER = 0;
/**
* Left alignment for table cells.
* @see #tableRows(int[], boolean)
*/
int JUSTIFY_LEFT = 1;
/**
* Right alignment for table cells.
* @see #tableRows(int[], boolean)
*/
int JUSTIFY_RIGHT = 2;
/**
* Starts the head element.
*
* @see #head(SinkEventAttributes)
*/
void head();
/**
* Starts the head element.
*
*
* This contains information about the current document, (eg its title) that is not
* considered document content. The head element is optional but if it exists, it has to be
* unique within a sequence of Sink events that produces one output document, and it has
* to come before the {@link #body(SinkEventAttributes)} element.
*
*
* The canonical sequence of events for the head element is:
*
* but none of the enclosed events is required. However, if they exist they have to occur
* in the order shown, and the title() and date() events have to be unique (author() events
* may occur any number of times).
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void head( SinkEventAttributes attributes );
/**
* Ends the head element.
*/
void head_();
/**
* Starts the title element.
*
* @see #title(SinkEventAttributes)
*/
void title();
/**
* Starts the title element. This is used to identify the document.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #head(SinkEventAttributes)
*/
void title( SinkEventAttributes attributes );
/**
* Ends the title element.
*/
void title_();
/**
* Starts an author element.
*
* @see #author(SinkEventAttributes)
*/
void author();
/**
* Starts an author element. This is used to identify the author of the document.
*
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #head(SinkEventAttributes)
*/
void author( SinkEventAttributes attributes );
/**
* Ends an author element.
*/
void author_();
/**
* Starts the date element.
*
* The date is recommended (but it is not a requirement) to be align to the
* ISO-8601
* standard, i.e.:
*
* YYYY-MM-DD
*
* where
*
*
YYYY is the year in the Gregorian calendar
*
MM is the month of the year between 01 (January) and 12 (December)
*
and DD is the day of the month between 01 and 31
*
*
* @see #date(SinkEventAttributes)
*/
void date();
/**
* Starts the date element. This is used to identify the date of the document.
*
*
* Supported attributes are: none.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #head(SinkEventAttributes)
*/
void date( SinkEventAttributes attributes );
/**
* Ends the date element.
*/
void date_();
/**
* Starts the body of a document.
*
* @see #body(SinkEventAttributes)
*/
void body();
/**
* Starts the body of a document. This contains the document's content.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #head(SinkEventAttributes)
*/
void body( SinkEventAttributes attributes );
/**
* Ends the body element.
*/
void body_();
/**
* Starts a title heading element.
*/
void sectionTitle();
/**
* Ends a title heading element.
*/
void sectionTitle_();
/**
* Starts a first heading element which contains the topic of the section.
*
* @see #section(int,SinkEventAttributes)
*/
void section1();
/**
* Ends a first heading element.
*/
void section1_();
/**
* Starts a first title heading element. This element is optional, but if it exists,
* it has to be contained, and be the first element, within a {@link #section1()} element.
*
* @see #sectionTitle(int,SinkEventAttributes)
*/
void sectionTitle1();
/**
* Ends a first title heading element.
*/
void sectionTitle1_();
/**
* Starts a second heading element which contains the topic of the section.
* This has to be contained within a {@link #section1()} element.
*
* @see #section(int,SinkEventAttributes)
*/
void section2();
/**
* Ends a second heading element.
*/
void section2_();
/**
* Starts a second title heading element. This element is optional, but if it exists,
* it has to be contained, and be the first element, within a {@link #section2()} element.
*
* @see #sectionTitle(int,SinkEventAttributes)
*/
void sectionTitle2();
/**
* Ends a second title heading element.
*/
void sectionTitle2_();
/**
* Starts a third heading element which contains the topic of the section.
* This has to be contained within a {@link #section2()} element.
*
* @see #section(int,SinkEventAttributes)
*/
void section3();
/**
* Ends a third heading element.
*/
void section3_();
/**
* Starts a third title heading element. This element is optional, but if it exists,
* it has to be contained, and be the first element, within a {@link #section3()} element.
*
* @see #sectionTitle(int,SinkEventAttributes)
*/
void sectionTitle3();
/**
* Ends a third title heading element.
*/
void sectionTitle3_();
/**
* Starts a 4th heading element which contains the topic of the section.
* This has to be contained within a {@link #section3()} element.
*
* @see #section(int,SinkEventAttributes)
*/
void section4();
/**
* Ends a 4th heading element.
*/
void section4_();
/**
* Starts a 4th title heading element. This element is optional, but if it exists,
* it has to be contained, and be the first element, within a {@link #section4()} element.
*
* @see #sectionTitle(int,SinkEventAttributes)
*/
void sectionTitle4();
/**
* Ends a 4th title heading element.
*/
void sectionTitle4_();
/**
* Starts a 5th heading element which contains the topic of the section.
* This has to be contained within a {@link #section4()} element.
*
* @see #section(int,SinkEventAttributes)
*/
void section5();
/**
* Ends a 5th heading element.
*/
void section5_();
/**
* Starts a 5th title heading element. This element is optional, but if it exists,
* it has to be contained, and be the first element, within a {@link #section5()} element.
*
* @see #sectionTitle(int,SinkEventAttributes)
*/
void sectionTitle5();
/**
* Ends a 5th title heading element.
*/
void sectionTitle5_();
/**
* Start a new section at the given level.
*
*
* Sections with higher level have to be entirely contained within sections of lower level.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param level the section level.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void section( int level, SinkEventAttributes attributes );
/**
* Ends a section at the given level.
*
* @param level the section level.
* @since 1.1
*/
void section_( int level );
/**
* Start a new section title at the given level.
*
*
* This element is optional, but if it exists, it has to be contained, and be the first
* element, within a corresponding {@link #section(int,SinkEventAttributes) section}
* element of the same level.
*
*
* NOTE: It is strongly recommended not to make section titles implicit anchors.
* Neither Parsers nor Sinks should insert any content that is not explicitly present
* in the original source document, as this would lead to undefined behaviour for
* multi-format processing chains. However, while Parsers must never emit anchors
* for section titles, some specialized Sinks may implement such a feature if the resulting
* output documents are not going to be further processed (and this is properly documented).
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus
* {@link SinkEventAttributes#ALIGN ALIGN}.
*
*
* @param level the section title level.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void sectionTitle( int level, SinkEventAttributes attributes );
/**
* Ends a section title at the given level.
*
* @param level the section title level.
* @since 1.1
*/
void sectionTitle_( int level );
/**
* Starts an unordered list element.
*
* @see #list(SinkEventAttributes)
*/
void list();
/**
* Starts an unordered list.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void list( SinkEventAttributes attributes );
/**
* Ends an unordered list element.
*/
void list_();
/**
* Starts a list item element within an unordered list.
*
* @see #listItem(SinkEventAttributes)
*/
void listItem();
/**
* Starts a list item element within an unordered list.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void listItem( SinkEventAttributes attributes );
/**
* Ends a list item element within an unordered list.
*/
void listItem_();
/**
* Starts an ordered list element.
*
* @param numbering the numbering style.
* @see #numberedList(int,SinkEventAttributes)
*/
void numberedList( int numbering );
/**
* Starts an ordered list element.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param numbering the numbering style.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #NUMBERING_DECIMAL
* @see #NUMBERING_LOWER_ALPHA
* @see #NUMBERING_LOWER_ROMAN
* @see #NUMBERING_UPPER_ALPHA
* @see #NUMBERING_UPPER_ROMAN
*/
void numberedList( int numbering, SinkEventAttributes attributes );
/**
* Ends an ordered list element.
*/
void numberedList_();
/**
* Starts a list item element within an ordered list.
*
* @see #numberedListItem(SinkEventAttributes)
*/
void numberedListItem();
/**
* Starts a list item element within an ordered list.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void numberedListItem( SinkEventAttributes attributes );
/**
* Ends a list item element within an ordered list.
*/
void numberedListItem_();
/**
* Starts a definition list element.
*
* @see #definitionList(SinkEventAttributes)
*/
void definitionList();
/**
* Starts a definition list.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void definitionList( SinkEventAttributes attributes );
/**
* Ends a definition list element.
*/
void definitionList_();
/**
* Starts a list item element within a definition list.
*
* @see #definitionListItem(SinkEventAttributes)
*/
void definitionListItem();
/**
* Starts a list item element within a definition list.
*
*
* Every definitionListItem has to contain exactly one {@link #definedTerm(SinkEventAttributes)}
* and one {@link #definition(SinkEventAttributes)}, in this order.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void definitionListItem( SinkEventAttributes attributes );
/**
* Ends a list item element within a definition list.
*/
void definitionListItem_();
/**
* Starts a definition element within a definition list.
*
* @see #definition(SinkEventAttributes)
*/
void definition();
/**
* Starts a definition element within a definition list.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void definition( SinkEventAttributes attributes );
/**
* Ends a definition element within a definition list.
*/
void definition_();
/**
* Starts a definition term element within a definition list.
*
* @see #definedTerm(SinkEventAttributes)
*/
void definedTerm();
/**
* Starts a definition term element within a definition list.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void definedTerm( SinkEventAttributes attributes );
/**
* Starts a definition term element within a definition list.
*/
void definedTerm_();
/**
* Starts a basic image embedding element.
*
* @see #figure(SinkEventAttributes)
*/
void figure();
/**
* Starts a basic image embedding element.
*
*
* The canonical sequence of events for the figure element is:
*
* However, NOTE that the order of figureCaption and
* figureGraphics events is arbitrary,
* ie a parser may emit the figureCaption before or after the figureGraphics.
* Implementing sinks should be prepared to handle both possibilities.
*
*
* NOTE also that the figureGraphics() event does not have to be embedded
* inside figure(), in particular for in-line images the figureGraphics() should be used
* stand-alone (in HTML language, figureGraphics() produces a <img>
* tag, while figure() opens a paragraph- or <div>- like environment).
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void figure( SinkEventAttributes attributes );
/**
* Ends a basic image embedding element.
*/
void figure_();
/**
* Starts a caption of an image element.
*
* @see #figureCaption(SinkEventAttributes)
*/
void figureCaption();
/**
* Starts a figure caption.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #figure(SinkEventAttributes)
*/
void figureCaption( SinkEventAttributes attributes );
/**
* Ends a caption of an image.
*/
void figureCaption_();
/**
* Adding a source of a graphic.
*
* @param name the source
*/
void figureGraphics( String name );
/**
* Adds a graphic element.
*
*
* The src parameter should be a valid link, ie it can be an absolute
* URL or a link relative to the current source document.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
* If the {@link SinkEventAttributes#SRC SRC} attribute is specified in SinkEventAttributes,
* it will be overridden by the src parameter.
*
*
* @param src the image source, a valid URL.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #figure(SinkEventAttributes)
*/
void figureGraphics( String src, SinkEventAttributes attributes );
/**
* Starts a table element for marking up tabular information in a document.
*
* @see #table(SinkEventAttributes)
*/
void table();
/**
* Starts a table.
*
*
* The canonical sequence of events for the table element is:
*
* However, NOTE that the order of tableCaption and
* {@link #tableRows(int[],boolean)} events is arbitrary,
* ie a parser may emit the tableCaption before or after the tableRows.
* Implementing sinks should be prepared to handle both possibilities.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void table( SinkEventAttributes attributes );
/**
* Ends a table element.
*/
void table_();
/**
* Starts an element that contains rows of table data.
*
* @param justification the default justification of columns.
* This can be overridden by individual table rows or table cells.
* If null a left alignment is assumed by default. If this array
* has less elements than there are columns in the table then the value of
* the last array element will be taken as default for the remaining table cells.
* @param grid true to provide a grid, false otherwise.
* @see #table(SinkEventAttributes)
* @see #JUSTIFY_CENTER
* @see #JUSTIFY_LEFT
* @see #JUSTIFY_RIGHT
*/
void tableRows( int[] justification, boolean grid );
/**
* Ends an element that contains rows of table data.
*/
void tableRows_();
/**
* Starts a row element which acts as a container for a row of table cells.
*
* @see #tableRow(SinkEventAttributes)
*/
void tableRow();
/**
* Starts a table row.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void tableRow( SinkEventAttributes attributes );
/**
* Ends a row element.
*/
void tableRow_();
/**
* Starts a cell element which defines a cell that contains data.
*
* @see #tableCell(SinkEventAttributes)
*/
void tableCell();
/**
* Starts a cell element which defines a cell that contains data.
*
* @param width the size of the cell.
* @deprecated Use #tableCell(SinkEventAttributes) instead.
*/
void tableCell( String width );
/**
* Starts a table cell.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void tableCell( SinkEventAttributes attributes );
/**
* Ends a cell element.
*/
void tableCell_();
/**
* Starts a cell element which defines a cell that contains header information.
*
* @see #tableHeaderCell(SinkEventAttributes)
*/
void tableHeaderCell();
/**
* Starts a cell element which defines a cell that contains header information.
*
* @param width the size of the header cell.
* @deprecated Use #tableHeaderCell(SinkEventAttributes) instead.
*/
void tableHeaderCell( String width );
/**
* Starts a table header cell.
*
*
* Supported attributes are the same as for {@link #tableCell(SinkEventAttributes) tableCell}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void tableHeaderCell( SinkEventAttributes attributes );
/**
* Ends a cell header element.
*/
void tableHeaderCell_();
/**
* Starts a caption element of a table.
*
* @see #tableCaption(SinkEventAttributes)
*/
void tableCaption();
/**
* Starts a table caption.
*
*
* Note that the order of tableCaption and
* {@link #tableRows(int[],boolean)} events is arbitrary,
* ie a parser may emit the tableCaption before or after the tableRows.
* Implementing sinks should be prepared to handle both possibilities.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}
* plus {@link SinkEventAttributes#ALIGN ALIGN}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
* @see #table(SinkEventAttributes)
*/
void tableCaption( SinkEventAttributes attributes );
/**
* Ends a caption element of a table.
*/
void tableCaption_();
/**
* Starts an element which represents a paragraph.
*
* @see #paragraph(SinkEventAttributes)
*/
void paragraph();
/**
* Starts a paragraph.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}
* plus {@link SinkEventAttributes#ALIGN ALIGN}.
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void paragraph( SinkEventAttributes attributes );
/**
* Ends a paragraph element.
*/
void paragraph_();
/**
* Starts an element which indicates that whitespace in the enclosed text has semantic relevance.
*
* @param boxed true to add a box, false otherwise
* @deprecated Use #verbatim(SinkEventAttributes) instead.
*/
void verbatim( boolean boxed );
/**
* Starts a verbatim block, ie a block where whitespace has semantic relevance.
*
*
* Text in a verbatim block must only be wrapped at the linebreaks in the source,
* and spaces should not be collapsed. It should be displayed in a fixed-width font to
* retain the formatting but the overall size may be chosen by the implementation.
*
*
*
* Most Sink events may be emitted within a verbatim block, the only elements explicitly
* forbidden are font-changing events and figures. Also, verbatim blocks may not be nested.
*
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void verbatim( SinkEventAttributes attributes );
/**
* Ends a verbatim element.
*/
void verbatim_();
/**
* Adding a separator of sections from a text to each other.
*
* @see #horizontalRule(SinkEventAttributes)
*/
void horizontalRule();
/**
* Adds a horizontal separator rule.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void horizontalRule( SinkEventAttributes attributes );
/**
* Adding a new page separator.
*/
void pageBreak();
/**
* Starts an element which defines an anchor.
*
* @param name the name of the anchor.
* @see #anchor(String,SinkEventAttributes)
*/
void anchor( String name );
/**
* Starts an element which defines an anchor.
*
*
* ID and NAME tokens must begin with a letter ([A-Za-z]) and may be
* followed by any number of letters, digits ([0-9]), hyphens ("-"),
* underscores ("_"), colons (":"), and periods (".").
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes}.
* If {@link SinkEventAttributes#NAME NAME} is specified in the SinkEventAttributes,
* it will be overwritten by the name parameter.
*
*
* @param name the name of the anchor. This has to be a valid SGML NAME token.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void anchor( String name, SinkEventAttributes attributes );
/**
* Ends an anchor element.
*/
void anchor_();
/**
* Starts an element which defines a link.
*
* @param name the name of the link.
* @see #link(String,SinkEventAttributes)
*/
void link( String name );
/**
* Starts a link.
*
*
* The name parameter has to be a valid html href
* parameter, ie for internal links (links to an anchor within the same source
* document), name should start with the character "#".
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus:
*
* If {@link SinkEventAttributes#HREF HREF} is specified in the
* SinkEventAttributes, it will be overwritten by the name parameter.
*
*
* @param name the name of the link.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void link( String name, SinkEventAttributes attributes );
/**
* Ends a link element.
*/
void link_();
/**
* Starts an italic element.
*
* Alternatively one may use {@link #text(String,SinkEventAttributes)} with
* {@link SinkEventAttributes#STYLE STYLE} instead.
*/
void italic();
/**
* Ends an italic element.
*
* Alternatively one may use {@link #text(String,SinkEventAttributes)} with
* {@link SinkEventAttributes#STYLE STYLE} instead.
*/
void italic_();
/**
* Starts a bold element.
*
* Alternatively one may use {@link #text(String,SinkEventAttributes)} with
* {@link SinkEventAttributes#STYLE STYLE} instead.
*/
void bold();
/**
* Ends a bold element.
*
* Alternatively one may use {@link #text(String,SinkEventAttributes)} with
* {@link SinkEventAttributes#STYLE STYLE} instead.
*/
void bold_();
/**
* Starts a monospaced element.
*
* Alternatively one may use {@link #text(String,SinkEventAttributes)} with
* {@link SinkEventAttributes#STYLE STYLE} instead.
*/
void monospaced();
/**
* Ends a monospaced element.
*
* Alternatively one may use {@link #text(String,SinkEventAttributes)} with
* {@link SinkEventAttributes#STYLE STYLE} instead.
*/
void monospaced_();
/**
* Adds a line break.
*
* @see #lineBreak(SinkEventAttributes)
*/
void lineBreak();
/**
* Adds a line break.
*
*
*
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void lineBreak( SinkEventAttributes attributes );
/**
* Adding a non breaking space, ie a space without any special formatting operations.
*/
void nonBreakingSpace();
/**
* Adding a text.
*
* @param text The text to write.
* @see #text(String,SinkEventAttributes)
*/
void text( String text );
/**
* Adds a text.
*
*
* The text parameter should contain only real content, ie any
* ignorable/collapsable whitespace/EOLs or other pretty-printing should
* be removed/normalized by a parser.
*
*
* If text contains any variants of line terminators, they should
* be normalized to the System EOL by an implementing Sink.
*
*
* Supported attributes are the {@link SinkEventAttributes base attributes} plus
*
*
* @param text The text to write.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void text( String text, SinkEventAttributes attributes );
/**
* Adding a raw text, ie a text without any special formatting operations.
*
* @param text The text to write.
*/
void rawText( String text );
/**
* Add a comment.
*
* @param comment The comment to write.
* @since 1.1
*/
void comment( String comment );
/**
* Add an unknown event. This may be used by parsers to notify a general Sink about
* an event that doesn't fit into any event defined by the Sink API.
* Depending on the parameters, a Sink may decide whether or not to process the event,
* emit it as raw text, as a comment, log it, etc.
*
* @param name The name of the event.
* @param requiredParams An optional array of required parameters to the event.
* May be null.
* @param attributes A set of {@link SinkEventAttributes}, may be null.
* @since 1.1
*/
void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes );
/**
* Flush the writer or the stream, if needed.
* Flushing a previously-flushed Sink has no effect.
*/
void flush();
/**
* Close the writer or the stream, if needed.
* Closing a previously-closed Sink has no effect.
*/
void close();
}
doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributes.java 0000644 0001750 0001750 00000022216 11132225264 032037 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.MutableAttributeSet;
/**
* A set of attributes for a sink event.
*
* All sink methods that produce some presentation-level output should have at least
* one form that allows to pass in a Set of SinkEventAttributes. For instance in
*
* the attributes parameter can be used to specify some text styling
* options, or other optional parameters.
*
*
* What kind of attributes are supported depends on the event and the sink
* implementation. The sink API just specifies a list of suggested attribute
* names, that sinks are expected to recognize, and parsers are expected to use
* preferably when emitting events.
*
*
* It is recommended that for simple attributes, both keys and values should be
* lower-case Strings, but this is not mandatory. One example of an exception is
* the {@link #STYLE} attribute, whose value may itself be an AttributeSet again.
*
*
* The base attributes that are supported by almost all events are
* {@link #CLASS}, {@link #ID}, {@link #LANG}, {@link #STYLE} and {@link #TITLE}.
*
*
* @author ltheussl
* @version $Id: SinkEventAttributes.java 733395 2009-01-10 23:09:40Z ltheussl $
* @since 1.1
*/
public interface SinkEventAttributes
extends MutableAttributeSet
{
// base
/**
* The class of the event element.
*/
String CLASS = "class";
/**
* A unique id for the event element.
*/
String ID = "id";
/**
* The language code for the event element.
*/
String LANG = "lang";
/**
* An inline style definition.
*
*
* Generally supported values are "italic", "bold", "monospaced" and AttributeSets.
*
*
* If the value of this Attribute is itself an AttributeSet, it is interpreted as a
* sequence of CSS properties. For instance, the HTML paragraph opening
*
*
* <p style="color: red; margin-left: 20px">
*
*
* can be produced by an HTML Sink via the event
* {@link Sink#paragraph(SinkEventAttributes)}, where the value of the
* SinkEventAttribute is an AttributeSet with two Attributes ("color" and
* "margin-left" with values "red" and "20px",
* respectively).
*
*/
String STYLE = "style";
/**
* A text to display in a tool tip.
*/
String TITLE = "title";
// head
/**
* A space separated list of URL's that contains meta data information about the document.
*/
String PROFILE = "profile";
/**
* An electronic mail address.
*/
String EMAIL = "email";
// img
/**
* Specifies the alignment of the event element within its parent element.
*
*
* Generally supported values are "left", "right", "center", "justify".
*
*/
String ALIGN = "align";
/**
* Defines a short description of the event element.
*/
String ALT = "alt";
/**
* Defines a border around an event element.
*/
String BORDER = "border";
/**
* Defines the height of an event element.
*/
String HEIGHT = "height";
/**
* Defines white space on the left and right side of an event element.
*/
String HSPACE = "hspace";
/**
* Defines an image as a server-side image map. Only used by the figureGraphics Sink event.
*/
String ISMAP = "ismap";
/**
* The URL of an external resource, eg an image.
*/
String SRC = "src";
/**
* Defines an image as a client-side image map.
*/
String USEMAP = "usemap";
/**
* Defines white space on the top and bottom of the event element.
*/
String VSPACE = "vspace";
/**
* Sets the width of an event element.
*/
String WIDTH = "width";
// hr
/**
* Used to indicate that an element comes with a shadow.
*/
String NOSHADE = "noshade";
/**
* Specifies the size, or thickness, or height of an event element.
*/
String SIZE = "size";
// anchor
/**
* Specifies the name of an anchor.
*/
String NAME = "name";
// link
/**
* Specifies the character encoding of text associated with an event element.
*/
String CHARSET = "charset";
/**
* May be used in conjunction with {@link #SHAPE}.
*
*
* Valid values are the same as for the corresponding HTML attributes.
*
*/
String COORDS = "coords";
/**
* The target URL of an event element, eg a link.
*/
String HREF = "href";
/**
* Specifies the base language of the target URL.
*
*
* Used in conjunction with {@link #HREF}.
*
*/
String HREFLANG = "hreflang";
/**
* For references to external resourcs, specifies the relationship between
* the current document and the target URL.
*
*
* Valid values are the same as for the corresponding HTML attribute.
*
*/
String REL = "rel";
/**
* For references to external resourcs, specifies the relationship between
* the target URL and the current document.
*
*
* Valid values are the same as for the corresponding HTML attribute.
*
*/
String REV = "rev";
/**
* Defines the type of region to be defined for a mapping.
*
*
* Used with the {@link #COORDS} attribute.
*
*/
String SHAPE = "shape";
/**
* Where to open the target URL.
*
*
* Valid values are the same as for the corresponding HTML attribute.
*
*/
String TARGET = "target";
/**
* Specifies the MIME (Multipurpose Internet Mail Extensions) type of an
* external resource URL, eg a link.
*/
String TYPE = "type";
// table
/**
* Specifies the background color of an event element.
*/
String BGCOLOR = "bgcolor";
/**
* Specifies the space between cell walls and contents.
*/
String CELLPADDING = "cellpadding";
/**
* Specifies the space between cells.
*/
String CELLSPACING = "cellspacing";
/**
* Specifies which sides of a border surrounding an element should be visible.
*
*
* Valid values are the same as for the corresponding HTML attribute.
*
*/
String FRAME = "frame";
/**
* Specifies horizontal/vertical divider lines between certain elements, eg table cells.
*/
String RULES = "rules";
/**
* Specifies a summary of an event attribute for speech-synthesizing/non-visual target output.
*/
String SUMMARY = "summary";
// table cell
/**
* Specifies an abbreviated version of the content in an element.
*/
String ABBRV = "abbrv";
/**
* Defines a name for a cell.
*/
String AXIS = "axis";
/**
* Indicates the number of columns a cell should span. Used in tables.
*/
String COLSPAN = "colspan";
/**
* A space-separated list of cell IDs that supply header information for the cell.
*/
String HEADERS = "headers";
/**
* Whether to disable or enable automatic text wrapping for an element.
*/
String NOWRAP = "nowrap";
/**
* Indicates the number of rows a cell should span. Used in tables.
*/
String ROWSPAN = "rowspan";
/**
* A general scope parameter. In Particular, for table cells this
* specifies if the cell provides header information for the rest of the
* row that contains it ("row"), or for the rest of the column ("col"),
* or for the rest of the row group that contains it ("rowgroup"),
* or for the rest of the column group that contains it ("colgroup").
*/
String SCOPE = "scope";
/**
* Specifies the vertical alignment of an element.
*
*
* Generally accepted values are "top", "baseline", "middle", "bottom", "sup", "sub".
*
*/
String VALIGN = "valign";
// text
/**
* Specifies a decoration for an element.
*
*
* Generally accepted values are "underline", "overline", "line-through", "boxed".
*
*/
String DECORATION = "decoration";
}
doxia-1.1.4/doxia-sink-api/src/main/java/org/apache/maven/doxia/sink/SinkFactory.java 0000644 0001750 0001750 00000005536 11135346161 030327 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.IOException;
import java.io.OutputStream;
/**
* A factory that creates a Sink object.
*
* @author Kenney Westerhof
* @version $Id: SinkFactory.java 736010 2009-01-20 13:06:57Z vsiveton $
* @since 1.0-alpha-9
*/
public interface SinkFactory
{
/** The Plexus SinkFactory Role. */
String ROLE = SinkFactory.class.getName();
/**
* Create a Sink into a file.
*
* @param outputDir the not-null output dir.
* @param outputName the not-null output name.
* @return a Sink instance with a file as output.
* @throws java.io.IOException if any
*/
Sink createSink( File outputDir, String outputName )
throws IOException;
/**
* Create a Sink into a file using a specified encoding.
*
* @param outputDir the not-null output dir.
* @param outputName the not-null output name.
* @param encoding the output encoding.
* @return a Sink instance with a file as output and using specified encoding.
* @throws java.io.IOException if any
* @see #createSink(File, String)
* @since 1.1
*/
Sink createSink( File outputDir, String outputName, String encoding )
throws IOException;
/**
* Create a Sink into an OutputStream.
*
* @param out not null OutputStream to write the result.
* @return a Sink instance.
* @throws java.io.IOException if any
* @since 1.1
*/
Sink createSink( OutputStream out )
throws IOException;
/**
* Create a Sink into an OutputStream using a specified encoding.
*
* @param out not null OutputStream to write the result.
* @param encoding the output encoding.
* @return a Sink instance using specified encoding.
* @throws java.io.IOException if any
* @since 1.1
*/
Sink createSink( OutputStream out, String encoding )
throws IOException;
}
doxia-1.1.4/doxia-sink-api/src/main/java/org/codehaus/ 0000755 0001750 0001750 00000000000 11632765561 022426 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/codehaus/doxia/ 0000755 0001750 0001750 00000000000 11632765561 023532 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/codehaus/doxia/sink/ 0000755 0001750 0001750 00000000000 11632765561 024476 5 ustar twerner twerner doxia-1.1.4/doxia-sink-api/src/main/java/org/codehaus/doxia/sink/Sink.java 0000644 0001750 0001750 00000002155 11105052714 026230 0 ustar twerner twerner package org.codehaus.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Generic document processing interface.
*
* @deprecated use {@link org.apache.maven.doxia.sink.Sink} instead (since 1.0-alpha-6).
* @version $Id: Sink.java 712143 2008-11-07 14:50:52Z hboutemy $
*/
public interface Sink
extends org.apache.maven.doxia.sink.Sink
{
// nop
}
doxia-1.1.4/doxia-logging-api/ 0000755 0001750 0001750 00000000000 11632765550 016070 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/pom.xml 0000644 0001750 0001750 00000003002 11470562366 017400 0 ustar twerner twerner
4.0.0doxiaorg.apache.maven.doxia1.1.4../pom.xmldoxia-logging-apiDoxia :: Logging APIDoxia Logging API.org.codehaus.plexusplexus-container-default
doxia-1.1.4/doxia-logging-api/src/ 0000755 0001750 0001750 00000000000 11632765550 016657 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/site/ 0000755 0001750 0001750 00000000000 11632765550 017623 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 021276 0 ustar twerner twerner
doxia-1.1.4/doxia-logging-api/src/main/ 0000755 0001750 0001750 00000000000 11632765550 017603 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/ 0000755 0001750 0001750 00000000000 11632765550 020524 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765550 021313 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765550 022534 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765550 023642 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765550 024746 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/ 0000755 0001750 0001750 00000000000 11632765550 026374 5 ustar twerner twerner doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/LogEnabled.java 0000644 0001750 0001750 00000002506 11132225264 031222 0 ustar twerner twerner package org.apache.maven.doxia.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* An interface for Doxia components (mainly Sink, Parser and Macro) that need the ability to log.
*
* Based on org.codehaus.plexus.logging.LogEnabled.
*
* @author ltheussl
* @version $Id: LogEnabled.java 733395 2009-01-10 23:09:40Z ltheussl $
* @since 1.1
*/
public interface LogEnabled
{
/**
* Enable a Doxia logger for this Doxia component.
*
* @param log a Log.
*/
void enableLogging( Log log );
}
doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/Log.java 0000644 0001750 0001750 00000013431 11216135717 027754 0 ustar twerner twerner package org.apache.maven.doxia.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* This interface supplies the API for providing feedback to the user from
* a Parser or Sink, using standard Doxia channels.
*
* There should be no big surprises here, although you may notice that the methods accept
* java.lang.CharSequence rather than java.lang.String. This is provided mainly as a
* convenience, to enable developers to pass things like java.lang.StringBuffer directly into the logger,
* rather than formatting first by calling toString().
*
* Based on org.apache.maven.plugin.logging.Log.
*
* @author jdcasey
* @author ltheussl
* @version $Id: Log.java 785531 2009-06-17 09:47:59Z ltheussl $
* @since 1.1
*/
public interface Log
{
/** Typecode for debugging messages. */
int LEVEL_DEBUG = 0;
/** Typecode for informational messages. */
int LEVEL_INFO = 1;
/** Typecode for warning messages. */
int LEVEL_WARN = 2;
/** Typecode for error messages. */
int LEVEL_ERROR = 3;
/** Typecode for fatal error messages. */
int LEVEL_FATAL = 4;
/** Typecode for disabled log levels. */
int LEVEL_DISABLED = 5;
/**
* Set the current log level.
*
* @param level the log level to set.
*/
void setLogLevel( int level );
/**
*
isDebugEnabled.
*
* @return true if the debug error level is enabled.
*/
boolean isDebugEnabled();
/**
* Send a message to the user in the debug error level.
*
* @param content the message to log.
*/
void debug( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the debug error level.
*
* The error's stacktrace will be output when this error level is enabled.
*
* @param content the message to log.
* @param error the error to log.
*/
void debug( CharSequence content, Throwable error );
/**
* Send an exception to the user in the debug error level.
*
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error the error to log.
*/
void debug( Throwable error );
/**
*
isInfoEnabled.
*
* @return true if the info error level is enabled.
*/
boolean isInfoEnabled();
/**
* Send a message to the user in the info error level.
*
* @param content the message to log.
*/
void info( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the info error level.
*
* The error's stacktrace will be output when this error level is enabled.
*
* @param content the message to log.
* @param error the error to log.
*/
void info( CharSequence content, Throwable error );
/**
* Send an exception to the user in the info error level.
*
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error the error to log.
*/
void info( Throwable error );
/**
*
isWarnEnabled.
*
* @return true if the warn error level is enabled.
*/
boolean isWarnEnabled();
/**
* Send a message to the user in the warn error level.
*
* @param content the message to log.
*/
void warn( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the warn error level.
*
* The error's stacktrace will be output when this error level is enabled.
*
* @param content the message to log.
* @param error the error to log.
*/
void warn( CharSequence content, Throwable error );
/**
* Send an exception to the user in the warn error level.
*
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error the error to log.
*/
void warn( Throwable error );
/**
*
isErrorEnabled.
*
* @return true if the error error level is enabled.
*/
boolean isErrorEnabled();
/**
* Send a message to the user in the error error level.
*
* @param content the message to log.
*/
void error( CharSequence content );
/**
* Send a message (and accompanying exception) to the user in the error error level.
*
* The error's stacktrace will be output when this error level is enabled.
*
* @param content the message to log.
* @param error the error to log.
*/
void error( CharSequence content, Throwable error );
/**
* Send an exception to the user in the error error level.
*
* The stack trace for this exception will be output when this error level is enabled.
*
* @param error the error to log.
*/
void error( Throwable error );
}
doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/PlexusLoggerWrapper.java 0000644 0001750 0001750 00000010572 11216135717 033217 0 ustar twerner twerner package org.apache.maven.doxia.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.codehaus.plexus.logging.Logger;
/**
* Wrap a Plexus logger into a Doxia logger.
* Based on org.apache.maven.plugin.logging.Log.
*
* @author Vincent Siveton
* @version $Id: PlexusLoggerWrapper.java 785531 2009-06-17 09:47:59Z ltheussl $
* @since 1.1
*/
public class PlexusLoggerWrapper
implements Log
{
private final Logger logger;
/**
*
Constructor for PlexusLoggerWrapper.
*
* @param logger the Plexus logger to wrap.
*/
public PlexusLoggerWrapper( Logger logger )
{
this.logger = logger;
}
/** {@inheritDoc} */
public void setLogLevel( int level )
{
if ( level <= LEVEL_DEBUG )
{
logger.setThreshold( Logger.LEVEL_DEBUG );
}
else if ( level <= LEVEL_INFO )
{
logger.setThreshold( Logger.LEVEL_INFO );
}
else if ( level <= LEVEL_WARN )
{
logger.setThreshold( Logger.LEVEL_WARN );
}
else if ( level <= LEVEL_ERROR )
{
logger.setThreshold( Logger.LEVEL_ERROR );
}
else
{
logger.setThreshold( Logger.LEVEL_DISABLED );
}
}
/** {@inheritDoc} */
public void debug( CharSequence content )
{
logger.debug( toString( content ) );
}
/** {@inheritDoc} */
public void debug( CharSequence content, Throwable error )
{
logger.debug( toString( content ), error );
}
/** {@inheritDoc} */
public void debug( Throwable error )
{
logger.debug( "", error );
}
/** {@inheritDoc} */
public void info( CharSequence content )
{
logger.info( toString( content ) );
}
/** {@inheritDoc} */
public void info( CharSequence content, Throwable error )
{
logger.info( toString( content ), error );
}
/** {@inheritDoc} */
public void info( Throwable error )
{
logger.info( "", error );
}
/** {@inheritDoc} */
public void warn( CharSequence content )
{
logger.warn( toString( content ) );
}
/** {@inheritDoc} */
public void warn( CharSequence content, Throwable error )
{
logger.warn( toString( content ), error );
}
/** {@inheritDoc} */
public void warn( Throwable error )
{
logger.warn( "", error );
}
/** {@inheritDoc} */
public void error( CharSequence content )
{
logger.error( toString( content ) );
}
/** {@inheritDoc} */
public void error( CharSequence content, Throwable error )
{
logger.error( toString( content ), error );
}
/** {@inheritDoc} */
public void error( Throwable error )
{
logger.error( "", error );
}
/** {@inheritDoc} */
public boolean isDebugEnabled()
{
return logger.isDebugEnabled();
}
/** {@inheritDoc} */
public boolean isInfoEnabled()
{
return logger.isInfoEnabled();
}
/** {@inheritDoc} */
public boolean isWarnEnabled()
{
return logger.isWarnEnabled();
}
/** {@inheritDoc} */
public boolean isErrorEnabled()
{
return logger.isErrorEnabled();
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
private String toString( CharSequence content )
{
if ( content == null )
{
return "";
}
return content.toString();
}
}
doxia-1.1.4/doxia-logging-api/src/main/java/org/apache/maven/doxia/logging/SystemStreamLog.java 0000644 0001750 0001750 00000013377 11132225264 032340 0 ustar twerner twerner package org.apache.maven.doxia.logging;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.PrintWriter;
import java.io.StringWriter;
/**
* Logger with "standard" output and error output stream. The log prefix is voluntarily in lower case.
*
* Based on org.apache.maven.plugin.logging.SystemStreamLog.
*
* @author jdcasey
* @author ltheussl
* @version $Id: SystemStreamLog.java 733395 2009-01-10 23:09:40Z ltheussl $
* @since 1.1
*/
public class SystemStreamLog
implements Log
{
private static final String EOL = System.getProperty( "line.separator" );
private int currentLevel = LEVEL_INFO;
/** {@inheritDoc} */
public void setLogLevel( int level )
{
if ( level <= LEVEL_DEBUG )
{
currentLevel = LEVEL_DEBUG;
}
else if ( level <= LEVEL_INFO )
{
currentLevel = LEVEL_INFO;
}
else if ( level <= LEVEL_WARN )
{
currentLevel = LEVEL_WARN;
}
else if ( level <= LEVEL_ERROR )
{
currentLevel = LEVEL_ERROR;
}
else
{
currentLevel = LEVEL_DISABLED;
}
}
/** {@inheritDoc} */
public void debug( CharSequence content )
{
if ( isDebugEnabled() )
{
print( "debug", content );
}
}
/** {@inheritDoc} */
public void debug( CharSequence content, Throwable error )
{
if ( isDebugEnabled() )
{
print( "debug", content, error );
}
}
/** {@inheritDoc} */
public void debug( Throwable error )
{
if ( isDebugEnabled() )
{
print( "debug", error );
}
}
/** {@inheritDoc} */
public void info( CharSequence content )
{
if ( isInfoEnabled() )
{
print( "info", content );
}
}
/** {@inheritDoc} */
public void info( CharSequence content, Throwable error )
{
if ( isInfoEnabled() )
{
print( "info", content, error );
}
}
/** {@inheritDoc} */
public void info( Throwable error )
{
if ( isInfoEnabled() )
{
print( "info", error );
}
}
/** {@inheritDoc} */
public void warn( CharSequence content )
{
if ( isWarnEnabled() )
{
print( "warn", content );
}
}
/** {@inheritDoc} */
public void warn( CharSequence content, Throwable error )
{
if ( isWarnEnabled() )
{
print( "warn", content, error );
}
}
/** {@inheritDoc} */
public void warn( Throwable error )
{
if ( isWarnEnabled() )
{
print( "warn", error );
}
}
/** {@inheritDoc} */
public void error( CharSequence content )
{
if ( isErrorEnabled() )
{
System.err.println( "[error] " + content.toString() );
}
}
/** {@inheritDoc} */
public void error( CharSequence content, Throwable error )
{
if ( isErrorEnabled() )
{
StringWriter sWriter = new StringWriter();
PrintWriter pWriter = new PrintWriter( sWriter );
error.printStackTrace( pWriter );
System.err.println( "[error] " + content.toString()
+ EOL + EOL + sWriter.toString() );
}
}
/** {@inheritDoc} */
public void error( Throwable error )
{
if ( isErrorEnabled() )
{
StringWriter sWriter = new StringWriter();
PrintWriter pWriter = new PrintWriter( sWriter );
error.printStackTrace( pWriter );
System.err.println( "[error] " + sWriter.toString() );
}
}
/** {@inheritDoc} */
public boolean isDebugEnabled()
{
return ( currentLevel <= LEVEL_DEBUG );
}
/** {@inheritDoc} */
public boolean isInfoEnabled()
{
return ( currentLevel <= LEVEL_INFO );
}
/** {@inheritDoc} */
public boolean isWarnEnabled()
{
return ( currentLevel <= LEVEL_WARN );
}
/** {@inheritDoc} */
public boolean isErrorEnabled()
{
return ( currentLevel <= LEVEL_ERROR );
}
//
// private
//
private void print( String prefix, CharSequence content )
{
System.out.println( "[" + prefix + "] " + content.toString() );
}
private void print( String prefix, Throwable error )
{
StringWriter sWriter = new StringWriter();
PrintWriter pWriter = new PrintWriter( sWriter );
error.printStackTrace( pWriter );
System.out.println( "[" + prefix + "] " + sWriter.toString() );
}
private void print( String prefix, CharSequence content, Throwable error )
{
StringWriter sWriter = new StringWriter();
PrintWriter pWriter = new PrintWriter( sWriter );
error.printStackTrace( pWriter );
System.out.println( "[" + prefix + "] " + content.toString()
+ EOL + EOL + sWriter.toString() );
}
}
doxia-1.1.4/doxia-modules/ 0000755 0001750 0001750 00000000000 11632765560 015344 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/ 0000755 0001750 0001750 00000000000 11632765557 020515 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/pom.xml 0000644 0001750 0001750 00000012314 11470562366 022024 0 ustar twerner twerner
4.0.0doxia-modulesorg.apache.maven.doxia1.1.4../pom.xmldoxia-module-fmlDoxia :: FML ModuleA Doxia module for FML source documents.org.codehaus.plexusplexus-utilsorg.apache.maven.doxiadoxia-test-docstestxercesxercesImpl2.9.1testorg.codehaus.modellomodello-maven-plugindescriptorgenerate-sourcesjavasrc/main/mdo/fml.mdo1.0.0org.codehaus.plexusplexus-maven-pluginsrc/main/components/components.xmltarget/generated-resources/plexus/META-INF/plexus/components.xmlmerge-descriptorsreportingorg.apache.maven.pluginsmaven-antrun-pluginsiterunxsddocxsddoc1.0antantorg.apache.antant-apache-regexp1.7.1xalanxalan2.7.1
doxia-1.1.4/doxia-modules/doxia-module-fml/src/ 0000755 0001750 0001750 00000000000 11632765557 021304 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/ 0000755 0001750 0001750 00000000000 11632765557 022263 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765557 024275 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/resources/simpleFaq.fml 0000644 0001750 0001750 00000002465 11215421102 026671 0 ustar twerner twerner
GeneralWhat does Maven mean?
A maven (yi.=meyvn) is an experienced or knowledgeable person, such as an expert or freak.
doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/resources/macro.fml 0000644 0001750 0001750 00000003230 11215421102 026040 0 ustar twerner twerner
Test the macro supportQuestion
A maven (yi.=meyvn) is an experienced or knowledgeable person, such as an expert or freak.
Where Can I Get Help?Where do I get help on Maven?
For help getting started, or basic use of Maven, refer to the documentation
that can be found from the left navigation of this site.
If these documents, and the other questions in this FAQ don't help you with your problem, the
Maven User List is a good source for help.
Lots of problems have already been discussed there, so please search the mailing list archive
before posting a question or a new idea.
Most of the Maven developers are subscribed to the Maven User List, so there is no need to post
to the Maven Developers list unless you want to discuss making a change to Maven itself.
Maven developers meet via IRC: irc.codehaus.org,
channel #maven.
But please don't ask for solutions to Maven problems there, as
Maven user problems should be discussed at the mailing list
for several good reasons (e.g. mail archive, more subscribers) and
usually you get a quick answer on the mailing list. But feel free to drop in and say hi.
You should not mail developers directly for Maven related issues, for 2 reasons. The most important
is that the project operates in the public, so all discussions should be kept on the list (for the
same reasons as given above). Secondly, they are busy and in various timezones, so mailing to the
list ensures you get the most prompt response from someone available and able to commit their time
at the moment. Direct questions to developers will rarely be answered.
How do I find help on a specific goal?
All Maven goals are provided by plugins. For example, the goals jar and jar:install
are provided by the jar plugin. You can find a list of
plugins and there documentation here.
Where can I get help on Jelly?
Jelly is a reasonably active project of it's own, used beyond Maven. If you have any questions about
it, including how to do certain Jelly things in a Maven build file, you should ask the question on
the Jelly mailing lists.
While the Maven User List archive is a good place to search for answers, it is preferred that you
only ask Jelly specific questions there if you were unable to find an answer on the Jelly lists.
ContributingI found a bug. How do I report it?
First, we'd appreciate if you search the Mailing List Archives
to see if anyone else has encountered it and found a resolution or a workaround.
If you are not using the current release of Maven, it is also worth trying that, and specifically
checking the release notes to see if that bug might have already been addressed.
If you are sure it is a bug, then it should go into JIRA, the issue tracking application for Maven.
First, search the Maven project (or related plugin) to see if the bug has already been reported.
If not, create a new issue. You must be registered and logged in to do so. This enables you to be
contacted if the bug is fixed or more information is required.
The location of Maven's JIRA instance is listed on the Issue Tracking
page.
Please be patient. While the issue will usually be reviewed immediately, bugs do not always get fixed as
quickly. However, if you are able to submit your own fix, it will usually be applied for the next release.
See Submitting Patches for more information.
I have such a cool new idea for a feature. Where do I suggest it?
Firstly - are you sure its a new idea? Try searching the Mailing List Archives
for both the user and developer lists to see if a similar idea has already been discussed.
Likewise, you should also search JIRA to see if someone has proposed
it as a feature request already.
If not, there are two ways to proceed. If you have a rough idea but think it needs some discussion with
the developers, try posting to the developers mailing list. So that they know initially that you have
already thought this through, briefly detail what you did or didn't find when searching the mail archives.
Once you are confident that the idea is solid and fits the current direction of the project, submit it to
JIRA as a feature request.
Please be patient. While the issue will usually be reviewed immediately, features are usually not
implemented until the start of the next major development cycle.
However, if you are able to submit your own implementation, it will usually be applied for the next release.
See Submitting Patches for more information.
How do I submit my own fix or new feature?
Bug fixes and features submitted by non-committers of the project take the form of a patch.
Submitting your own patch will ensure that the bug or feature gets addressed sooner, and gives
the submitter the warm fuzzy feeling from helping out!
Before working on a patch for a bug fix or new feature, it is essential that the steps above are followed
to ensure that there isn't already a patch, or that a new feature has been previously decided against
because it does not match the direction of the project. You don't want to waste time preparing a patch
if it won't be used, so please take the time to consult the current developers list in advance.
When preparing the patch, make sure it is against the latest code in version control by doing a full update
and testing it again. The easiest way to prepare the patch is then to run this in the base directory of
your source control checkout:
maven scm:create-patch
This is basically equivalent to running svn diff. Attach the resulting patch file to a JIRA
issue. Please rename it to the name of the JIRA issue so a developer can save it and still know what it is.
Do not mail it directly to a particular developer, or to the developers mailing list as attachments are
often stripped or the mails lost.
If you did not create the original JIRA issue, it is important that you select to "watch" the issue so
that feedback on the patch can be given.
If you are fixing a bug, make sure you submit a test case that fails without the patch, but succeeds with
the patch applied, proving that it works.
If you are submitting a new feature, it is important that you include test cases to verify the feature
works, and documentation for users on how it works.
It is important that you don't submit whole replacement files instead of differences or differences
where unrelated code is changed - such as changing formatting or spacing. Patches that violate these
rules will often not be applied.
Finally, adhere to the coding standards of the project, respecting the settings of the code surrounding
that of the change. This includes whitespace, and ensuring that spaces are used instead of tab characters.
If these rules are followed, you will usually find that developers will joyfully and quickly apply
the patch, and be appreciative of the efforts put in to help out.
Using MavenWhat's the problem with entities in project.xml?
As of Maven 1.1, external entities will not be enabled by default in
project.xml, and their use is discouraged in Maven 1.0.x as well.
There will still be the ability to use them, but it will have to be enabled.
There are several reasons for this, but the main reason is that
the content of project.xml needs to be completely self-contained and
and able to be reproduced from a history at any point in time.
For this reason, using Jelly expressions other than ${pom.*} references is
also not recommended and likely to be unsupported in future.
The most common use of this technique is to manage dependencies
across multiple projects. You should strongly consider using inheritence for this purpose.
Note: special character entities will always be supported and should
not have any current issues.
How do I stop my top level properties being inherited in subprojects? I only want to inherit the
project.xml file.
This is a result of using the same project file at the top level of your multiple project structure as the
master build (ie, where you run your multiproject goals from) and the root of your
project inheritence tree.
We recommend that you separate these concerns by having both a master build project and a parent project
for extension (see the maven-plugins CVS tree for an example). Ther master build should remain
in the top level directory, but the shared project file should be in a subdirectory such as
common-build.
How do I make my build complete even with broken tests?
See the Test Plugin Reference.
Most notably, maven.test.skip and maven.test.failure.ignore.
Heed the warnings!
Where does the output from my JUnit tests go?
If you are running test:test, the exceptions will usually be output to
./target/test-reports/some.package.SomeClassTest.txt.
If you want to see the errors in the output, set the property maven.junit.usefile to
false.
How do I disable a report on my site?
The preferred way is to specify your own <reports/> section in the POM.
Reports are not inherited from parent projects, so only those included will be used.
The default reports are:
If there is one specific report you want to disable, you can do so with a post-goal. For example,
to disable linkcheck whenever the maven.linkcheck.disable property is set, add this to
your maven.xml file:
linkcheck is disabled.]]>How do I use Maven with XDoclet?
The XDoclet plugin is provided by the XDoclet developers. All questions
about it should be directed to the XDoclet mailing lists.
Maven takes a long time to load. Is there anyway to speed things up?
You can use the
Console Plugin to
get an interactive shell that will let load Maven once and run as many
goals as you want. On average machines it takes something like
ten seconds to compile and run unit tests, so that you can build often
and test your code often.
Do I need to specify all the dependencies in the POM?
The short answer is YES. Maven 2 will have a transitive dependency discovery mechanism
that will avoid this.
How do I provide multiple source directories in my project.xml?
You can't. However, if you really need it, you can use a snippet in maven.xml:
]]>
Please think about the reason you need this, and carefully consider whether it is necessary. Usually this
is used for writing plugins that handle source generation.
How can I customise the configuration for an entire installation?
Currently you can only configure settings at a project and per-user level.
There are no site-wise configuration settings available.
If you would like to write certain information to a file and piping is not an option or you want
greater control over what is controlled, you can override the log4j configuration. Refer to the log4j
documentation for how to override this using system properties.
Why shouldn't I use the dependency classloader override property?
Because in most cases it isn't needed. root.maven is equivalent to the project classloader,
so is never needed.
While root is the Ant classloader and has some valid uses, you should
not load tasks into it unless absolutely necessary as it will then force itself
on the other plugins executed afterwards. In particular any jakarta-commons libraries should not be in the
root classloader as these can clash with Jelly.
The correct way to use ant tasks in maven.xml or a plugin is something like:
]]>How do I add a JAR from a non-Maven project to my local repository?
If it is a JAR that cannot be uploaded to Ibiblio because of a license, or it is private,
you must manually copy it to your local repository. After picking a sensible group ID, and making
sure the filename is in the format artifactId-version.jar, copy it to
${maven.repo.local}/groupId/jars/artifactId-version.jar.
I share a development machine. How can I share the local repository to save downloading?
It is recommended that you do not share your local repository. The reason for this is that as you
build your projects, part of the process is usually to install your changes there for sharing with other
projects you are working on that depend on it.
If you share this with multiple developers, you will have to communicate with them about when you will
be developing a certain project to ensure your changes don't clash, and ensure each person is always
completely up to date.
Usually, it is better to work with a shared remote repository that you run yourself. This means that
dependencies are only downloaded once from the internet, and then downloaded to the local cache for each
developer as they need it. Company artifacts can also be published there.
If after this you really want to share a local repository, you can set the maven.repo.local
property. This is a directory (not a URL). The directory pointed to must be readable by all of the users
and may need to be writable if the users will be allowed to download dependencies or publish their changes.
The file system mask must also be set correctly so that changes retain the correct permissions.
Please note that this solution will not be supported by the Maven Users Mailing List, however.
IbiblioWhy is the Maven repository on Ibiblio and not at Apache?
There are several reasons why the Maven Repository was setup at
Ibiblio. Ibiblio is a massive archive of almost everything you could
imagine but one of the stated goals of Ibiblio is to "Expand and improve the distribution
of open source software". There is really no limit to how much we can stuff
in the repository at Ibiblio and it will be archived indefinitely. They have
a lot of bandwith, good redundancy and have a very secure setup. Another reason
we placed the repository there was that it is Apache policy not to store
any (L)GPL artifacts on our servers. We wanted Maven to work for as many
Java developers as possible so we chose Ibiblio where there is no restriction
on store (L)GPL artifacts. You can find out more about Ibiblio
here.
How do I upload a resource to or update a resource on http://www.ibiblio.org/maven?
Are there any mirrors for the Maven repository at ibiblio?
Yes, there are at least the following:
http://www.ibiblio.org/maven/
http://public.planetmirror.com/pub/maven/
http://mirrors.sunsite.dk/maven/
http://ftp.up.ac.za/pub/linux/maven/
http://download.au.kde.org/pub/maven/
Can I search the repositories?
There is a service available at
http://maven.ozacc.com/
that provides a search service, though not affiliated with the
Maven project.
ScriptingHow do I get or set plugin properties from Jelly?
Plugin properties can be used with the following tags:
maven:get and
maven:set.
(These replace the deprecated versions of ${pom.getPluginContext(...).get/setVariable()}
and maven:pluginVar.)
Example:
The WAR source directory is ${warSourceDir}
...
]]>How do I spin off a background process in a goal?
For example, before starting unit tests you might need to start a DB server. The DB server blocks until it is
terminated, so it needs to be started in the background. <ant:parallel/> does not seem to
work in this case because it blocks the main execution thread, which is exactly what needs to be avoided.
A common symptom is that the Jelly or Ant tag are output instead of being processed.
See MAVEN-156.
The solution is to add the JAXP system property via the Jelly script.
]]>
Also make sure that Xalan is declared as dependencies in your project file, and added to the root classloader
so that Ant can find it:
xalanxalan2.3.1http://xml.apache.org/xalan/root
]]>How do I share build code between projects?
Write your own Maven plugin. It's not as difficult as you may
think it is, and it will probably save you much time when
your code grows in size.
Please read the Developing Plugins
documentation for instructions on how to do this.
It can also be helpful to refer to the source code for the existing
Maven plugins which you already have installed.
How do I share my Maven plugin with others?
Read Sharing Plugins.
Troubleshooting MavenHow can I get Maven to give more verbose output?
If you received an exception at the end and want a full stack trace for more
information, you can run the same maven command again with the -e
switch, eg:
maven -e jar:jar
If you would like a full set of debugging information to trace what Maven is doing,
you can run the same maven command again with the -X
switch, eg:
maven -X jar:jar
Note that -X implies -e, so there is no need to use both.
Why do the unit tests fail under Java 1.4?
It is possible that the XML parser included with Maven is
interfering with the XML parser included in Java 1.4. Please set
the ${maven.junit.fork}property to
yes.
Why does change log ask me to check out the source code?
When you run the cvs change log report in Maven, you may see an
error occasionally, such as:
This is caused by the cvs log command finding a directory in it's
repository that you don't have locally. Note: The directory may not
appear on a checkout or update if it is empty in the repository.
Please do a clean checkout of the code and retry the report.
I have problems generating the changelog report. Why?
When you run the cvs change log report in Maven, the report hangs or the
final output is blank.
This is typically caused by the cvs command not running correctly.
The first port of call is to check Maven's output, search the lines containing for "SCM".
Try running the command that you find in the log file manually. The results typically
speak for themselves.
maven site fails with bizarre Jelly errors, what can I do?
When I try to generate my site I get something like this:
Invalid source argument. Must be a String, Reader,
InputStream or URL. Was type; java.io.File with value:
/home/jvanzyl/js/com.werken/drools/target/jdepend-raw-report.xml
Total time: 12 seconds]]>
This problem has been observed when a version of Jelly used as a
dependency is different than the one distributed with Maven.
If you align your versions of Jelly you should be able to generate
your site.
AntWhat is the equivalent of ant -projecthelp in Maven?
To some extent, maven -u behaves the same way. For more information, please read the
Quick Start guide.
I've heard Maven is much slower than Ant. Is there anything I can do to make it faster?
This has become a bit of an urban myth now, as Maven takes very little more than Ant
to initialise (with the exception of the very first run when plugins must be unpacked and parsed).
Part of the misconception comes from claims that building the site or building 30 projects
takes a lot of CPU and memory. Well, this would happen in Ant too if it were attempted!
Some extensions to Ant that build a web site take considerably longer than Maven to do that task.
This area is also a focus for future development so that generating these parts of the build
are much faster.
When it comes down to your day to day development and edit-build-test cycle, you
can speed up Maven's initialisation time by running the console, as shown in
this FAQ answer.
This console keeps Maven loaded and ready to do your bidding for a specific project, and
makes Maven faster than Ant for performing equivalent, subsequent builds!
How can I filter properties into resource files as part of the build?
This can be done using resource filtering. In your POM, add the filtering property to your existing
resources definition. Please refer to Resources for more information.
You typically need to set your HTTP proxy host and port details so that Maven can tunnel through your
HTTP Proxy. To do this you typically need to set the maven.proxy.host and
maven.proxy.port properties.
See the
Properties Reference for more details.
doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/ 0000755 0001750 0001750 00000000000 11632765557 023204 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765557 023773 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 025214 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 026322 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 027426 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 030713 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/ 0000755 0001750 0001750 00000000000 11632765557 031471 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlParserTest.java doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlParser0000644 0001750 0001750 00000032377 11215523277 033307 0 ustar twerner twerner package org.apache.maven.doxia.module.fml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileReader;
import java.io.Reader;
import java.io.Writer;
import java.util.Iterator;
import java.util.List;
import org.apache.maven.doxia.parser.AbstractParserTest;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
import org.apache.maven.doxia.sink.XhtmlBaseSink;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
/**
* @author Emmanuel Venisse
* @version $Id: FmlParserTest.java 784948 2009-06-15 19:53:35Z ltheussl $
*/
public class FmlParserTest
extends AbstractParserTest
{
private FmlParser parser;
/** {@inheritDoc} */
protected void setUp()
throws Exception
{
super.setUp();
parser = (FmlParser) lookup( Parser.ROLE, "fml" );
// AbstractXmlParser.CachedFileEntityResolver downloads DTD/XSD files in ${java.io.tmpdir}
// Be sure to delete them
String tmpDir = System.getProperty( "java.io.tmpdir" );
String excludes = "fml-*.xsd, xml.xsd";
List tmpFiles = FileUtils.getFileNames( new File( tmpDir ), excludes, null, true );
for ( Iterator it = tmpFiles.iterator(); it.hasNext(); )
{
File tmpFile = new File( it.next().toString() );
tmpFile.delete();
}
}
/** {@inheritDoc} */
protected Parser createParser()
{
return parser;
}
/** {@inheritDoc} */
protected String outputExtension()
{
return "fml";
}
/** @throws Exception */
public void testFaqEventsList()
throws Exception
{
SinkEventTestingSink sink = new SinkEventTestingSink();
Reader reader = null;
try
{
reader = getTestReader( "simpleFaq" );
createParser().parse( reader, sink );
}
finally
{
IOUtil.close( reader );
}
Iterator it = sink.getEventList().iterator();
assertEquals( "comment", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "title", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "title_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "anchor", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "bold", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "bold_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedList", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedListItem", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedListItem_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedList_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definitionList", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definedTerm", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "anchor", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definedTerm_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definition", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definition_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definitionList_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testEntities()
throws Exception
{
final String text = "]>"
+ "<Α"
+ ">Α"
+ "
<img>"Α
"
+ "";
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.setValidate( false );
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "title", ( (SinkEventElement) it.next() ).getName() );
// head title TODO: should be two events
assertTextEvent( (SinkEventElement) it.next(), "&Α" );
assertEquals( "title_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "anchor", ( (SinkEventElement) it.next() ).getName() );
// faq title TODO: should be two events
assertTextEvent( (SinkEventElement) it.next(), "&Α" );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "bold", ( (SinkEventElement) it.next() ).getName() );
// part title in TOC
assertTextEvent( (SinkEventElement) it.next(), "<" );
assertTextEvent( (SinkEventElement) it.next(), "\u0391" );
assertEquals( "bold_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedList", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedListItem", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link", ( (SinkEventElement) it.next() ).getName() );
// question in TOC
assertTextEvent( (SinkEventElement) it.next(), ">" );
assertTextEvent( (SinkEventElement) it.next(), "\u0391" );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedListItem_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "numberedList_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1", ( (SinkEventElement) it.next() ).getName() );
// part title
assertTextEvent( (SinkEventElement) it.next(), "<" );
assertTextEvent( (SinkEventElement) it.next(), "\u0391" );
assertEquals( "sectionTitle1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definitionList", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definedTerm", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "anchor", ( (SinkEventElement) it.next() ).getName() );
// question
assertTextEvent( (SinkEventElement) it.next(), ">" );
assertTextEvent( (SinkEventElement) it.next(), "\u0391" );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definedTerm_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definition", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
// answer
assertEquals( "monospaced", ( (SinkEventElement) it.next() ).getName() );
assertTextEvent( (SinkEventElement) it.next(), "<" );
assertTextEvent( (SinkEventElement) it.next(), "img" );
assertTextEvent( (SinkEventElement) it.next(), ">" );
assertEquals( "monospaced_", ( (SinkEventElement) it.next() ).getName() );
assertTextEvent( (SinkEventElement) it.next(), "\"" );
assertTextEvent( (SinkEventElement) it.next(), "\u0391" );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definition_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "definitionList_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/**
* @throws Exception if any
* @since 1.1.1
*/
public void testFaqMacro()
throws Exception
{
Writer output = null;
Reader reader = null;
try
{
output = getTestWriter( "macro" );
reader = getTestReader( "macro" );
Sink sink = new XhtmlBaseSink( output );
createParser().parse( reader, sink );
sink.close();
}
finally
{
IOUtil.close( output );
IOUtil.close( reader );
}
File f = getTestFile( getBasedir(), outputBaseDir() + getOutputDir() + "macro.fml" );
assertTrue( "The file " + f.getAbsolutePath() + " was not created", f.exists() );
String content;
try
{
reader = new FileReader( f );
content = IOUtil.toString( reader );
}
finally
{
IOUtil.close( reader );
}
assertTrue( content.indexOf( "Macro Question" ) != -1 );
}
private void assertTextEvent( SinkEventElement textEvt, String string )
{
assertEquals( "text", textEvt.getName() );
assertEquals( string, textEvt.getArgs()[0] );
}
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValidatorTest.java doxia-1.1.4/doxia-modules/doxia-module-fml/src/test/java/org/apache/maven/doxia/module/fml/FmlValida0000644 0001750 0001750 00000005232 11215421102 033221 0 ustar twerner twerner package org.apache.maven.doxia.module.fml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.doxia.markup.XmlMarkup;
import org.apache.maven.doxia.xsd.AbstractXmlValidatorTest;
import org.codehaus.plexus.util.StringUtils;
/**
* Test FML files with namespace.
*
* @author Vincent Siveton
* @version $Id: FmlValidatorTest.java 784718 2009-06-15 10:28:18Z vsiveton $
* @since 1.0
*/
public class FmlValidatorTest
extends AbstractXmlValidatorTest
{
/** The xsd to use */
private static final File FML_XSD = new File( getBasedir(), "/src/main/resources/fml-1.0.1.xsd" );
/** {@inheritDoc} */
protected void setUp()
throws Exception
{
super.setUp();
}
/** {@inheritDoc} */
protected void tearDown()
throws Exception
{
super.tearDown();
}
/** {@inheritDoc} */
protected String[] getIncludes()
{
return new String[] { "**/*.fml" };
}
/** {@inheritDoc} */
protected String addNamespaces( String content )
{
Pattern pattern = Pattern.compile( ".*<([A-Za-z][A-Za-z0-9:_.-]*)([^>]*)>.*" );
Matcher matcher = pattern.matcher( content );
if ( matcher.find() )
{
String root = matcher.group( 1 );
String value = matcher.group( 2 );
if ( value.indexOf( FML_XSD.getName() ) == -1 )
{
String faqs =
"<" + root + " xmlns=\"" + FmlMarkup.FML_NAMESPACE + "\""
+ " xmlns:xsi=\"" + XmlMarkup.XML_NAMESPACE + "\""
+ " xsi:schemaLocation=\"" + FmlMarkup.FML_NAMESPACE + " " + FML_XSD.toURI() + "\" ";
return StringUtils.replace( content, "<" + root, faqs );
}
}
return content;
}
}
doxia-1.1.4/doxia-modules/doxia-module-fml/src/site/ 0000755 0001750 0001750 00000000000 11632765557 022250 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/site/apt/ 0000755 0001750 0001750 00000000000 11632765557 023034 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/site/apt/using-fml-xsd.apt 0000644 0001750 0001750 00000002655 11215434414 026225 0 ustar twerner twerner -----
Using Schema FML 1.0.1
-----
Vincent Siveton
------
2009-06-15
------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Using Schema FML 1.0.1
The FML XSD is located {{{http://maven.apache.org/xsd/fml-1.0.1.xsd}here}}.
Your favorite IDE probably supports XSD schema's for .fml files. You need to specify the following:
+-----+
...
+-----+
doxia-1.1.4/doxia-modules/doxia-module-fml/src/site/site.xml 0000644 0001750 0001750 00000002573 11215434414 023723 0 ustar twerner twerner
doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/ 0000755 0001750 0001750 00000000000 11632765557 022230 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/resources/ 0000755 0001750 0001750 00000000000 11632765557 024242 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/resources/fml-1.0.1.xsd 0000644 0001750 0001750 00000256007 11215421102 026151 0 ustar twerner twerner
Doxia FML (FAQ Markup Language) 1.0.1 XML Schema.
This is based on: Extensible HTML version 1.0 Transitional XML Schema
http://www.w3.org/2002/08/xhtml/xhtml1-transitional.xsd
For further information, see:
http://maven.apache.org/doxia/references/fml-format.html
================ Character mnemonic entities =========================
XHTML entity sets are identified by the PUBLIC and SYSTEM identifiers:
PUBLIC "-//W3C//ENTITIES Latin 1 for XHTML//EN"
SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent"
PUBLIC "-//W3C//ENTITIES Special for XHTML//EN"
SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent"
PUBLIC "-//W3C//ENTITIES Symbols for XHTML//EN"
SYSTEM "http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent"
================== Imported Names ====================================
media type, as per [RFC2045]
comma-separated list of media types, as per [RFC2045]
a character encoding, as per [RFC2045]
a space separated list of character encodings, as per [RFC2045]
a language code, as per [RFC3066]
a single character, as per section 2.2 of [XML]
one or more digits
tabindex attribute specifies the position of the current element
in the tabbing order for the current document. This value must be
a number between 0 and 32767. User agents should ignore leading zeros.
space-separated list of link types
single or comma-separated list of media descriptors
a Uniform Resource Identifier, see [RFC2396]
a space separated list of Uniform Resource Identifiers
date and time information. ISO date format
script expression
style sheet data
used for titles etc.
render in this frame
nn for pixels or nn% for percentage length
pixel, percentage, or relative
integer representing length in pixels
these are used for image maps
comma separated list of lengths
used for object, applet, img, input and iframe
a color using sRGB: #RRGGBB as Hex values
There are also 16 widely known color names with their sRGB values:
Black = #000000 Green = #008000
Silver = #C0C0C0 Lime = #00FF00
Gray = #808080 Olive = #808000
White = #FFFFFF Yellow = #FFFF00
Maroon = #800000 Navy = #000080
Red = #FF0000 Blue = #0000FF
Purple = #800080 Teal = #008080
Fuchsia= #FF00FF Aqua = #00FFFF
=================== Generic Attributes ===============================
core attributes common to most elements
id document-wide unique id
class space separated list of classes
style associated style info
title advisory title/amplification
internationalization attributes
lang language code (backwards compatible)
xml:lang language code (as per XML 1.0 spec)
dir direction for weak/neutral text
attributes for common UI events
onclick a pointer button was clicked
ondblclick a pointer button was double clicked
onmousedown a pointer button was pressed down
onmouseup a pointer button was released
onmousemove a pointer was moved onto the element
onmouseout a pointer was moved away from the element
onkeypress a key was pressed and released
onkeydown a key was pressed down
onkeyup a key was released
attributes for elements that can get the focus
accesskey accessibility key character
tabindex position in tabbing order
onfocus the element got the focus
onblur the element lost the focus
text alignment for p, div, h1-h6. The default is
align="left" for ltr headings, "right" for rtl
=================== Text Elements ====================================
these can only occur at block level
these can only occur at block level
"Inline" covers inline or "text-level" element
================== Block level elements ==============================
"Flow" mixes block and inline and is used for list items etc.
================== Content models for exclusions =====================
a elements use "Inline" excluding a
pre uses "Inline" excluding img, object, applet, big, small,
font, or basefont
form uses "Flow" excluding form
button uses "Flow" but excludes a, form, form controls, iframe
================ Document Head =======================================
content model is "head.misc" combined with a single
title and an optional base element in any order
The title element is not considered part of the flow of text.
It should be displayed, for example as the page header or
window title. Exactly one title is required per document.
document base URI
generic metainformation
Relationship values can be used in principle:
a) for document specific toolbars/menus when used
with the link element in document head e.g.
start, contents, previous, next, index, end, help
b) to link to a separate style sheet (rel="stylesheet")
c) to make a link to a script (rel="script")
d) by stylesheets to control how collections of
html nodes are rendered into printed documents
e) to make a link to a printable version of this document
e.g. a PostScript or PDF version (rel="alternate" media="print")
style info, which may include CDATA sections
script statements, which may include CDATA sections
alternate content container for non script-based rendering
======================= Frames =======================================
inline subwindow
alternate content container for non frame-based rendering
=================== Document Body ====================================
generic language/style container
=================== Paragraphs =======================================
=================== Headings =========================================
There are six levels of headings from h1 (the most important)
to h6 (the least important).
=================== Lists ============================================
Unordered list bullet styles
Unordered list
Ordered list numbering style
1 arabic numbers 1, 2, 3, ...
a lower alpha a, b, c, ...
A upper alpha A, B, C, ...
i lower roman i, ii, iii, ...
I upper roman I, II, III, ...
The style is applied to the sequence number which by default
is reset to 1 for the first list item in an ordered list.
Ordered (numbered) list
single column list (DEPRECATED)
multiple column list (DEPRECATED)
LIStyle is constrained to: "(ULStyle|OLStyle)"
list item
definition lists - dt for term, dd for its definition
=================== Address ==========================================
information on author
=================== Horizontal Rule ==================================
=================== Preformatted Text ================================
content is "Inline" excluding
"img|object|applet|big|small|sub|sup|font|basefont"
=================== Block-like Quotes ================================
=================== Text alignment ===================================
center content
=================== Inserted/Deleted Text ============================
ins/del are allowed in block and inline content, but its
inappropriate to include block content within an ins element
occurring in inline content.
================== The Anchor Element ================================
content is "Inline" except that anchors shouldn't be nested
===================== Inline Elements ================================
generic language/style container
I18N BiDi over-ride
forced line break
emphasis
strong emphasis
definitional
program code
sample
something user would type
variable
citation
abbreviation
acronym
inlined quote
subscript
superscript
fixed pitch font
italic font
bold font
bigger font
smaller font
underline
strike-through
strike-through
base font size
local change to font
==================== Object ======================================
object is used to embed objects as part of HTML pages.
param elements should precede other content. Parameters
can also be expressed as attribute/value pairs on the
object element itself when brevity is desired.
param is used to supply a named property value.
In XML it would seem natural to follow RDF and support an
abbreviated syntax where the param elements are replaced
by attribute value pairs on the object start tag.
=================== Java applet ==================================
One of code or object attributes must be present.
Place param elements before other content.
=================== Images ===========================================
To avoid accessibility problems for people who aren't
able to see the image, you should provide a text
description using the alt and longdesc attributes.
In addition, avoid the use of server-side image maps.
usemap points to a map element which may be in this document
or an external document, although the latter is not widely supported
================== Client-side image maps ============================
These can be placed in the same document or grouped in a
separate document although this isn't yet widely supported
================ Forms ===============================================
Each label must not contain more than ONE field
Label elements shouldn't be nested.
form control
the name attribute is required for all but submit & reset
option selector
option group
selectable choice
multi-line text field
The fieldset element is used to group form fields.
Only one legend element should occur in the content
and if present should only be preceded by whitespace.
NOTE: this content model is different from the XHTML 1.0 DTD,
closer to the intended content model in HTML4 DTD
fieldset label
Content is "Flow" excluding a, form and form controls
single-line text input control (DEPRECATED)
======================= Tables =======================================
Derived from IETF HTML table standard, see [RFC1942]
The border attribute sets the thickness of the frame around the
table. The default units are screen pixels.
The frame attribute specifies which parts of the frame around
the table should be rendered. The values are not the same as
CALS to avoid a name clash with the valign attribute.
The rules attribute defines which rules to draw between cells:
If rules is absent then assume:
"none" if border is absent or border="0" otherwise "all"
horizontal placement of table relative to document
horizontal alignment attributes for cell contents
char alignment char, e.g. char=':'
charoff offset for alignment char
vertical alignment attributes for cell contents
Use thead to duplicate headers when breaking table
across page boundaries, or for static headers when
tbody sections are rendered in scrolling panel.
Use tfoot to duplicate footers when breaking table
across page boundaries, or for static footers when
tbody sections are rendered in scrolling panel.
Use multiple tbody sections when rules are needed
between groups of table rows.
colgroup groups a set of col elements. It allows you to group
several semantically related columns together.
col elements define the alignment properties for cells in
one or more columns.
The width attribute specifies the width of the columns, e.g.
width=64 width in screen pixels
width=0.5* relative width of 0.5
The span attribute causes the attributes of one
col element to apply to more than one column.
Scope is simpler than headers attribute for common tables
th is for headers, td for data and for cells acting as both
================== FML Specific =====================================
================ Document Structure ==================================
1.0.0
The <faqs/> element is the root of the FML descriptor.
1.0.0
Required part element for this faqs element.
1.0.0
The identifier for this faqs element.
1.0.0
The title for this faqs element.
1.0.0
Boolean to generate optionally [top] links.
1.0
A part element of the faqs element.
1.0.0
Optional title for this part element.
1.0.0
Required faq element for this part element.
1.0.0
The identifier for this part element.
1.0.0
A faq element.
1.0.0
The question of this faq element.
1.0.0
The answer of this faq element.
1.0.0
The identifier of this faq element.
1.0.0
A faq question element.
1.0.0
A faq answer element.
================ Document Addons =====================================
See "special.extra" group.
1.0.0
A source element.
1.0.1
A macro element.
doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/mdo/ 0000755 0001750 0001750 00000000000 11632765557 023007 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/mdo/fml.mdo 0000644 0001750 0001750 00000011474 11137602162 024253 0 ustar twerner twerner
fmlFmlpackageorg.apache.maven.doxia.module.fml.modelFaqs<faqs> element is the root of the FML descriptor.
The following table lists all of the possible child elements.
]]>1.0.0title1.0.0StringFAQtruetoplink1.0.0booleantruetrueparts1.0.0Part*truePart1.0.0id1.0.0Stringtruetitle1.0.0Stringtruefaqs1.0.0Faq*trueFaq1.0.0id1.0.0Stringtruequestion1.0.0Stringtrueanswer1.0.0Stringtrue
doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/components/ 0000755 0001750 0001750 00000000000 11632765557 024415 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/components/components.xml 0000644 0001750 0001750 00000002600 11215421102 027266 0 ustar twerner twerner
org.apache.maven.doxia.parser.Parserfmlorg.apache.maven.doxia.module.fml.FmlParserParse an xdoc model and emit events into the specified doxia Sink.org.apache.maven.doxia.macro.manager.MacroManagermacroManager
doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/ 0000755 0001750 0001750 00000000000 11632765557 023151 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765557 023740 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 025161 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 026267 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 027373 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 030660 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/ 0000755 0001750 0001750 00000000000 11632765557 031436 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlSiteModule.java doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlSiteMo0000644 0001750 0001750 00000002557 11212745470 033213 0 ustar twerner twerner package org.apache.maven.doxia.module.fml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
*
FmlSiteModule class.
*
* @author Emmanuel Venisse
* @version $Id: FmlSiteModule.java 782392 2009-06-07 14:14:16Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="fml"
*/
public class FmlSiteModule
extends AbstractSiteModule
{
/**
* Default constructor.
*/
public FmlSiteModule()
{
super( "fml", "fml", "fml" );
}
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlContentParser.java doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlConten0000644 0001750 0001750 00000007307 11244501034 033226 0 ustar twerner twerner package org.apache.maven.doxia.module.fml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.parser.XhtmlBaseParser;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Parse Fml questions and answers, these may contain arbitrary xdoc elements.
*
* @author ltheussl
* @version $Id: FmlContentParser.java 807169 2009-08-24 12:05:48Z vsiveton $
* @since 1.0
*/
public class FmlContentParser
extends XhtmlBaseParser
implements FmlMarkup
{
/** Empty elements don't write a closing tag. */
private boolean isEmptyElement;
/** {@inheritDoc} */
protected void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
isEmptyElement = parser.isEmptyElementTag();
if ( parser.getName().equals( QUESTION_TAG.toString() )
|| parser.getName().equals( TITLE.toString() )
|| parser.getName().equals( ANSWER_TAG.toString() ) )
{
// ignore
return;
}
else if ( parser.getName().equals( SOURCE_TAG.toString() ) )
{
verbatim();
sink.verbatim( SinkEventAttributeSet.BOXED );
}
else if ( !baseStartTag( parser, sink ) )
{
if ( isEmptyElement )
{
handleUnknown( parser, sink, TAG_TYPE_SIMPLE );
}
else
{
handleUnknown( parser, sink, TAG_TYPE_START );
}
if ( getLog().isDebugEnabled() )
{
String position = "[" + parser.getLineNumber() + ":"
+ parser.getColumnNumber() + "]";
String tag = "<" + parser.getName() + ">";
getLog().debug( "Unrecognized fml tag: " + tag + " at " + position );
}
}
}
/** {@inheritDoc} */
protected void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( parser.getName().equals( QUESTION_TAG.toString() )
|| parser.getName().equals( TITLE.toString() )
|| parser.getName().equals( ANSWER_TAG.toString() ) )
{
// ignore
return;
}
else if ( parser.getName().equals( SOURCE_TAG.toString() ) )
{
verbatim_();
sink.verbatim_();
}
else if ( !baseEndTag( parser, sink ) )
{
if ( !isEmptyElement )
{
handleUnknown( parser, sink, TAG_TYPE_END );
}
}
isEmptyElement = false;
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.isEmptyElement = false;
}
}
././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser.java doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlParser0000644 0001750 0001750 00000057261 11244501034 033240 0 ustar twerner twerner package org.apache.maven.doxia.module.fml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import javax.swing.text.html.HTML.Attribute;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.macro.manager.MacroNotFoundException;
import org.apache.maven.doxia.module.fml.model.Faq;
import org.apache.maven.doxia.module.fml.model.Faqs;
import org.apache.maven.doxia.module.fml.model.Part;
import org.apache.maven.doxia.parser.AbstractXmlParser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.XhtmlBaseSink;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Parse a fml model and emit events into the specified doxia Sink.
*
* @author Emmanuel Venisse
* @author ltheussl
* @version $Id: FmlParser.java 807169 2009-08-24 12:05:48Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="fml"
*/
public class FmlParser
extends AbstractXmlParser
implements FmlMarkup
{
/** Collect a faqs model. */
private Faqs faqs;
/** Collect a part. */
private Part currentPart;
/** Collect a single faq. */
private Faq currentFaq;
/** Used to collect text events. */
private StringBuffer buffer;
/** Map of warn messages with a String as key to describe the error type and a Set as value.
* Using to reduce warn messages. */
private Map warnMessages;
/** The source content of the input reader. Used to pass into macros. */
private String sourceContent;
/** A macro name. */
private String macroName;
/** The macro parameters. */
private Map macroParameters = new HashMap();
/** {@inheritDoc} */
public void parse( Reader source, Sink sink )
throws ParseException
{
this.faqs = null;
this.sourceContent = null;
init();
try
{
StringWriter contentWriter = new StringWriter();
IOUtil.copy( source, contentWriter );
sourceContent = contentWriter.toString();
}
catch ( IOException ex )
{
throw new ParseException( "Error reading the input source: " + ex.getMessage(), ex );
}
finally
{
IOUtil.close( source );
}
try
{
Reader tmp = new StringReader( sourceContent );
this.faqs = new Faqs();
// this populates faqs
super.parse( tmp, sink );
writeFaqs( sink );
}
finally
{
logWarnings();
this.faqs = null;
this.sourceContent = null;
setSecondParsing( false );
init();
}
}
/** {@inheritDoc} */
protected void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( parser.getName().equals( FAQS_TAG.toString() ) )
{
String title = parser.getAttributeValue( null, "title" );
if ( title != null )
{
faqs.setTitle( title );
}
String toplink = parser.getAttributeValue( null, "toplink" );
if ( toplink != null )
{
if ( toplink.equalsIgnoreCase( "true" ) )
{
faqs.setToplink( true );
}
else
{
faqs.setToplink( false );
}
}
}
else if ( parser.getName().equals( PART_TAG.toString() ) )
{
currentPart = new Part();
currentPart.setId( parser.getAttributeValue( null, Attribute.ID.toString() ) );
if ( currentPart.getId() == null )
{
throw new XmlPullParserException( "id attribute required for at: ("
+ parser.getLineNumber() + ":" + parser.getColumnNumber() + ")" );
}
else if ( !DoxiaUtils.isValidId( currentPart.getId() ) )
{
String linkAnchor = DoxiaUtils.encodeId( currentPart.getId(), true );
String msg = "Modified invalid link: '" + currentPart.getId() + "' to '" + linkAnchor + "'";
logMessage( "modifiedLink", msg );
currentPart.setId( linkAnchor );
}
}
else if ( parser.getName().equals( TITLE.toString() ) )
{
buffer = new StringBuffer();
buffer.append( String.valueOf( LESS_THAN ) ).append( parser.getName() )
.append( String.valueOf( GREATER_THAN ) );
}
else if ( parser.getName().equals( FAQ_TAG.toString() ) )
{
currentFaq = new Faq();
currentFaq.setId( parser.getAttributeValue( null, Attribute.ID.toString() ) );
if ( currentFaq.getId() == null )
{
throw new XmlPullParserException( "id attribute required for at: ("
+ parser.getLineNumber() + ":" + parser.getColumnNumber() + ")" );
}
else if ( !DoxiaUtils.isValidId( currentFaq.getId() ) )
{
String linkAnchor = DoxiaUtils.encodeId( currentFaq.getId(), true );
String msg = "Modified invalid link: '" + currentFaq.getId() + "' to '" + linkAnchor + "'";
logMessage( "modifiedLink", msg );
currentFaq.setId( linkAnchor );
}
}
else if ( parser.getName().equals( QUESTION_TAG.toString() ) )
{
buffer = new StringBuffer();
buffer.append( String.valueOf( LESS_THAN ) ).append( parser.getName() )
.append( String.valueOf( GREATER_THAN ) );
}
else if ( parser.getName().equals( ANSWER_TAG.toString() ) )
{
buffer = new StringBuffer();
buffer.append( String.valueOf( LESS_THAN ) ).append( parser.getName() )
.append( String.valueOf( GREATER_THAN ) );
}
// ----------------------------------------------------------------------
// Macro
// ----------------------------------------------------------------------
else if ( parser.getName().equals( MACRO_TAG.toString() ) )
{
handleMacroStart( parser );
}
else if ( parser.getName().equals( PARAM.toString() ) )
{
handleParamStart( parser, sink );
}
else if ( buffer != null )
{
buffer.append( String.valueOf( LESS_THAN ) ).append( parser.getName() );
int count = parser.getAttributeCount();
for ( int i = 0; i < count; i++ )
{
buffer.append( String.valueOf( SPACE ) ).append( parser.getAttributeName( i ) );
buffer.append( String.valueOf( EQUAL ) ).append( String.valueOf( QUOTE ) );
// TODO: why are attribute values HTML-encoded?
buffer.append( HtmlTools.escapeHTML( parser.getAttributeValue( i ) ) );
buffer.append( String.valueOf( QUOTE ) );
}
buffer.append( String.valueOf( GREATER_THAN ) );
}
}
/** {@inheritDoc} */
protected void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( parser.getName().equals( FAQS_TAG.toString() ) )
{
// Do nothing
return;
}
else if ( parser.getName().equals( PART_TAG.toString() ) )
{
faqs.addPart( currentPart );
currentPart = null;
}
else if ( parser.getName().equals( FAQ_TAG.toString() ) )
{
if ( currentPart == null )
{
throw new XmlPullParserException( "Missing at: ("
+ parser.getLineNumber() + ":" + parser.getColumnNumber() + ")" );
}
currentPart.addFaq( currentFaq );
currentFaq = null;
}
else if ( parser.getName().equals( QUESTION_TAG.toString() ) )
{
if ( currentFaq == null )
{
throw new XmlPullParserException( "Missing at: ("
+ parser.getLineNumber() + ":" + parser.getColumnNumber() + ")" );
}
buffer.append( String.valueOf( LESS_THAN ) ).append( String.valueOf( SLASH ) )
.append( parser.getName() ).append( String.valueOf( GREATER_THAN ) );
currentFaq.setQuestion( buffer.toString() );
buffer = null;
}
else if ( parser.getName().equals( ANSWER_TAG.toString() ) )
{
if ( currentFaq == null )
{
throw new XmlPullParserException( "Missing at: ("
+ parser.getLineNumber() + ":" + parser.getColumnNumber() + ")" );
}
buffer.append( String.valueOf( LESS_THAN ) ).append( String.valueOf( SLASH ) )
.append( parser.getName() ).append( String.valueOf( GREATER_THAN ) );
currentFaq.setAnswer( buffer.toString() );
buffer = null;
}
else if ( parser.getName().equals( TITLE.toString() ) )
{
if ( currentPart == null )
{
throw new XmlPullParserException( "Missing at: ("
+ parser.getLineNumber() + ":" + parser.getColumnNumber() + ")" );
}
buffer.append( String.valueOf( LESS_THAN ) ).append( String.valueOf( SLASH ) )
.append( parser.getName() ).append( String.valueOf( GREATER_THAN ) );
currentPart.setTitle( buffer.toString() );
buffer = null;
}
// ----------------------------------------------------------------------
// Macro
// ----------------------------------------------------------------------
else if ( parser.getName().equals( MACRO_TAG.toString() ) )
{
handleMacroEnd( buffer );
}
else if ( parser.getName().equals( PARAM.toString() ) )
{
if ( !StringUtils.isNotEmpty( macroName ) )
{
handleUnknown( parser, sink, TAG_TYPE_END );
}
}
else if ( buffer != null )
{
if ( buffer.length() > 0 && buffer.charAt( buffer.length() - 1 ) == SPACE )
{
buffer.deleteCharAt( buffer.length() - 1 );
}
buffer.append( String.valueOf( LESS_THAN ) ).append( String.valueOf( SLASH ) )
.append( parser.getName() ).append( String.valueOf( GREATER_THAN ) );
}
}
/** {@inheritDoc} */
protected void handleText( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
if ( buffer != null )
{
buffer.append( parser.getText() );
}
// only significant text content in fml files is in , or
}
/** {@inheritDoc} */
protected void handleCdsect( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String cdSection = parser.getText();
if ( buffer != null )
{
buffer.append( LESS_THAN ).append( BANG ).append( LEFT_SQUARE_BRACKET ).append( CDATA )
.append( LEFT_SQUARE_BRACKET ).append( cdSection ).append( RIGHT_SQUARE_BRACKET )
.append( RIGHT_SQUARE_BRACKET ).append( GREATER_THAN );
}
else
{
sink.text( cdSection );
}
}
/** {@inheritDoc} */
protected void handleComment( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String comment = parser.getText();
if ( buffer != null )
{
buffer.append( LESS_THAN ).append( BANG ).append( MINUS ).append( MINUS )
.append( comment ).append( MINUS ).append( MINUS ).append( GREATER_THAN );
}
else
{
sink.comment( comment.trim() );
}
}
/** {@inheritDoc} */
protected void handleEntity( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
if ( buffer != null )
{
if ( parser.getText() != null )
{
String text = parser.getText();
// parser.getText() returns the entity replacement text
// (< -> <), need to re-escape them
if ( text.length() == 1 )
{
text = HtmlTools.escapeHTML( text );
}
buffer.append( text );
}
}
else
{
super.handleEntity( parser, sink );
}
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.currentFaq = null;
this.currentPart = null;
this.buffer = null;
this.warnMessages = null;
this.macroName = null;
this.macroParameters = null;
}
/**
* TODO import from XdocParser, probably need to be generic.
*
* @param parser not null
* @throws MacroExecutionException if any
*/
private void handleMacroStart( XmlPullParser parser )
throws MacroExecutionException
{
if ( !isSecondParsing() )
{
macroName = parser.getAttributeValue( null, Attribute.NAME.toString() );
if ( macroParameters == null )
{
macroParameters = new HashMap();
}
if ( StringUtils.isEmpty( macroName ) )
{
throw new MacroExecutionException( "The '" + Attribute.NAME.toString()
+ "' attribute for the '" + MACRO_TAG.toString() + "' tag is required." );
}
}
}
/**
* TODO import from XdocParser, probably need to be generic.
*
* @param buffer not null
* @throws MacroExecutionException if any
*/
private void handleMacroEnd( StringBuffer buffer )
throws MacroExecutionException
{
if ( !isSecondParsing() )
{
if ( StringUtils.isNotEmpty( macroName ) )
{
// TODO handles specific macro attributes
macroParameters.put( "sourceContent", sourceContent );
FmlParser fmlParser = new FmlParser();
fmlParser.setSecondParsing( true );
macroParameters.put( "parser", fmlParser );
MacroRequest request = new MacroRequest( macroParameters, getBasedir() );
try
{
StringWriter sw = new StringWriter();
XhtmlBaseSink sink = new XhtmlBaseSink(sw);
executeMacro( macroName, request, sink );
sink.close();
buffer.append( sw.toString() );
} catch ( MacroNotFoundException me )
{
throw new MacroExecutionException( "Macro not found: " + macroName, me );
}
}
}
// Reinit macro
macroName = null;
macroParameters = null;
}
/**
* TODO import from XdocParser, probably need to be generic.
*
* @param parser not null
* @param sink not null
* @throws MacroExecutionException if any
*/
private void handleParamStart( XmlPullParser parser, Sink sink )
throws MacroExecutionException
{
if ( !isSecondParsing() )
{
if ( StringUtils.isNotEmpty( macroName ) )
{
String paramName = parser.getAttributeValue( null, Attribute.NAME.toString() );
String paramValue = parser.getAttributeValue( null,
Attribute.VALUE.toString() );
if ( StringUtils.isEmpty( paramName ) || StringUtils.isEmpty( paramValue ) )
{
throw new MacroExecutionException( "'" + Attribute.NAME.toString()
+ "' and '" + Attribute.VALUE.toString() + "' attributes for the '" + PARAM.toString()
+ "' tag are required inside the '" + MACRO_TAG.toString() + "' tag." );
}
macroParameters.put( paramName, paramValue );
}
else
{
// param tag from non-macro object, see MSITE-288
handleUnknown( parser, sink, TAG_TYPE_START );
}
}
}
/**
* Writes the faqs to the specified sink.
*
* @param faqs The faqs to emit.
* @param sink The sink to consume the event.
* @throws ParseException if something goes wrong.
*/
private void writeFaqs( Sink sink )
throws ParseException
{
FmlContentParser xdocParser = new FmlContentParser();
xdocParser.enableLogging( getLog() );
sink.head();
sink.title();
sink.text( faqs.getTitle() );
sink.title_();
sink.head_();
sink.body();
sink.section1();
sink.sectionTitle1();
sink.anchor( "top" );
sink.text( faqs.getTitle() );
sink.anchor_();
sink.sectionTitle1_();
// ----------------------------------------------------------------------
// Write summary
// ----------------------------------------------------------------------
for ( Iterator partIterator = faqs.getParts().iterator(); partIterator.hasNext(); )
{
Part part = (Part) partIterator.next();
if ( StringUtils.isNotEmpty( part.getTitle() ) )
{
sink.paragraph();
sink.bold();
xdocParser.parse( part.getTitle(), sink );
sink.bold_();
sink.paragraph_();
}
sink.numberedList( Sink.NUMBERING_DECIMAL );
for ( Iterator faqIterator = part.getFaqs().iterator(); faqIterator.hasNext(); )
{
Faq faq = (Faq) faqIterator.next();
sink.numberedListItem();
sink.link( "#" + faq.getId() );
if ( StringUtils.isNotEmpty( faq.getQuestion() ) )
{
xdocParser.parse( faq.getQuestion(), sink );
}
else
{
throw new ParseException( "Missing <question> for FAQ '" + faq.getId() + "'" );
}
sink.link_();
sink.numberedListItem_();
}
sink.numberedList_();
}
sink.section1_();
// ----------------------------------------------------------------------
// Write content
// ----------------------------------------------------------------------
for ( Iterator partIterator = faqs.getParts().iterator(); partIterator.hasNext(); )
{
Part part = (Part) partIterator.next();
if ( StringUtils.isNotEmpty( part.getTitle() ) )
{
sink.section1();
sink.sectionTitle1();
xdocParser.parse( part.getTitle(), sink );
sink.sectionTitle1_();
}
sink.definitionList();
for ( Iterator faqIterator = part.getFaqs().iterator(); faqIterator.hasNext(); )
{
Faq faq = (Faq) faqIterator.next();
sink.definedTerm();
sink.anchor( faq.getId() );
if ( StringUtils.isNotEmpty( faq.getQuestion() ) )
{
xdocParser.parse( faq.getQuestion(), sink );
}
else
{
throw new ParseException( "Missing <question> for FAQ '" + faq.getId() + "'" );
}
sink.anchor_();
sink.definedTerm_();
sink.definition();
if ( StringUtils.isNotEmpty( faq.getAnswer() ) )
{
xdocParser.parse( faq.getAnswer(), sink );
}
else
{
throw new ParseException( "Missing <answer> for FAQ '" + faq.getId() + "'" );
}
if ( faqs.isToplink() )
{
writeTopLink( sink );
}
if ( faqIterator.hasNext() )
{
sink.horizontalRule();
}
sink.definition_();
}
sink.definitionList_();
if ( StringUtils.isNotEmpty( part.getTitle() ) )
{
sink.section1_();
}
}
sink.body_();
}
/**
* Writes a toplink element.
*
* @param sink The sink to consume the event.
*/
private void writeTopLink( Sink sink )
{
SinkEventAttributeSet atts = new SinkEventAttributeSet();
atts.addAttribute( SinkEventAttributeSet.ALIGN, "right" );
sink.paragraph( atts );
sink.link( "#top" );
sink.text( "[top]" );
sink.link_();
sink.paragraph_();
}
/**
* If debug mode is enabled, log the <code>msg</code> as is, otherwise add unique msg in <code>warnMessages</code>.
*
* @param key not null
* @param msg not null
* @see #parse(Reader, Sink)
* @since 1.1.1
*/
private void logMessage( String key, String msg )
{
msg = "[FML Parser] " + msg;
if ( getLog().isDebugEnabled() )
{
getLog().debug( msg );
return;
}
if ( warnMessages == null )
{
warnMessages = new HashMap();
}
Set set = (Set) warnMessages.get( key );
if ( set == null )
{
set = new TreeSet();
}
set.add( msg );
warnMessages.put( key, set );
}
/**
* @since 1.1.1
*/
private void logWarnings()
{
if ( getLog().isWarnEnabled() && this.warnMessages != null && !isSecondParsing() )
{
for ( Iterator it = this.warnMessages.entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
Set set = (Set) entry.getValue();
for ( Iterator it2 = set.iterator(); it2.hasNext(); )
{
String msg = (String) it2.next();
getLog().warn( msg );
}
}
this.warnMessages = null;
}
}
}
././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup.java doxia-1.1.4/doxia-modules/doxia-module-fml/src/main/java/org/apache/maven/doxia/module/fml/FmlMarkup0000644 0001750 0001750 00000006125 11215421102 033227 0 ustar twerner twerner package org.apache.maven.doxia.module.fml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.markup.HtmlMarkup;
/**
* List of <code>FML</code> markups.
* <br/>
* FML uses several {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
* as markups and custom tags.
*
* @author ltheussl
* @version $Id: FmlMarkup.java 784718 2009-06-15 10:28:18Z vsiveton $
* @since 1.0
*/
public interface FmlMarkup
extends HtmlMarkup
{
/** FML namespace: "http://maven.apache.org/FML/1.0.1" */
String FML_NAMESPACE = "http://maven.apache.org/FML/1.0.1";
/** FML system id: "http://maven.apache.org/xsd/fml-1.0.1.xsd" */
String FML_SYSTEM_ID = "http://maven.apache.org/xsd/fml-1.0.1.xsd";
// ----------------------------------------------------------------------
// Specific Fml tags
// ----------------------------------------------------------------------
/** Fml tag for <code>faqs</code> */
Tag FAQS_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "faqs";
}
};
/** Fml tag for <code>part</code> */
Tag PART_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "part";
}
};
/** Fml tag for <code>faq</code> */
Tag FAQ_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "faq";
}
};
/** Fml tag for <code>question</code> */
Tag QUESTION_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "question";
}
};
/** Fml tag for <code>answer</code> */
Tag ANSWER_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "answer";
}
};
/** Fml tag for <code>source</code> */
Tag SOURCE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "source";
}
};
/**
* Fml tag for <code>macro</code>
* @since 1.1.1
*/
Tag MACRO_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "macro";
}
};
}
doxia-1.1.4/doxia-modules/doxia-module-twiki/ 0000755 0001750 0001750 00000000000 11632765560 021060 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/pom.xml 0000644 0001750 0001750 00000003431 11470562366 022375 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia-modules</artifactId>
<groupId>org.apache.maven.doxia</groupId>
<version>1.1.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>doxia-module-twiki</artifactId>
<name>Doxia :: TWiki Module</name>
<description>A Doxia module for Twiki source documents.</description>
<developers>
<developer>
<name>Juan F. Codagnone</name>
<email>juan *at* zauber dot. com dot. ar</email>
<roles>
<role>Developer</role>
</roles>
<timezone>-3</timezone>
</developer>
</developers>
<contributors>
<contributor>
<name>Christian Nardi</name>
<roles>
<role>Developer</role>
</roles>
</contributor>
</contributors>
</project>
doxia-1.1.4/doxia-modules/doxia-module-twiki/src/ 0000755 0001750 0001750 00000000000 11632765560 021647 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/ 0000755 0001750 0001750 00000000000 11632765560 022626 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765560 024640 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/resources/TWikiParserTest.twiki 0000644 0001750 0001750 00000004055 10524215463 030750 0 ustar twerner twerner ---+ Twiki Java Parser
---++ Features
This parser of the [[http://www.twiki.org][TWiki]] text format supports most
of http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules formatting commands.
---+++ General
* Paragraps,
* Wiki Words
* WikiWord
* Web.WikiWord#anchor,
* escaped: !WikiWord
* Forced Links:
* [[wiki word]]
* escaped ![[wiki word]]
* Specific links:
* [[http://www.zauber.com.ar][Zauber]],
* prevention: ![[http://www.zauber.com.ar][Forced links]]
* Anchors: [[#AnchorEnd][End]]
* inline urls:
* http://twiki.org/
* mailto link:
* [[mailto:a@z.com Mail]]
* [[mailto:?subject=Hi Hi]]
---+++ Text Format:
* *bold*
* _italic_
* __bold italic__
* =Fixedfont=
* ==Bold fixed==
And nested formats like:
* *bold with _italic_ and some =fixed= and bold*
Make sure there is no space between the text and the bold, italic, or other
indicators (* _ __ = ==).
---+++ Lists
* items
* nested items
* ordered list
* arabic numerals
1. item
1. item
1. ...
* uppercase letters
A. item
A. item
A. ...
* lowercase letters
a. item
a. item
a. ...
* uppercase roman numerals
A. item
A. item
A. ....
* Uppercase Roman Numerals
I. item
I. item
I. ...
* Lowercase Roman Numerals
i. item
i. item
i. ....
---+++ Separators
Up
---------------------------
Down
---+++ Table
| *A* | *B* | *C* |
| Foo | bar | Foo |
| Bar | Foo | bar |
| Foo | bar | Foo |
---++ Missing things
---+++ Verbating Mode
<verbatim>
class CatAnimal {
void purr() {
<code here>
}
</verbatim>
---+++ Definition List
(i don't use it)
$ Sushi: Japan
$ Dim Sum: S.F.
$ Asado: Argentina
---+++ Diable Links
<noautolink>
RedHat &
SuSE
</noautolink>
---+++ Html
* <pre>some text</pre>
#EndAnchor
doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/ 0000755 0001750 0001750 00000000000 11632765560 023547 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765560 024336 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765560 025557 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765560 026665 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765560 027771 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765560 031256 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/ 0000755 0001750 0001750 00000000000 11632765560 032405 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000162 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/TWikiSinkTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/TWiki0000644 0001750 0001750 00000015415 11207472163 033355 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractSinkTest;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
/**
* Test the TWiki Sink
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: TWikiSinkTest.java 779565 2009-05-28 11:24:35Z vsiveton $
* @see TWikiSink
*/
public class TWikiSinkTest
extends AbstractSinkTest
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new TWikiSink( writer );
}
/** {@inheritDoc} */
protected boolean isXmlSink()
{
return false;
}
/** {@inheritDoc} */
protected String getAnchorBlock( String anchor )
{
return EOL + "#" + anchor + anchor;
}
/** Not used.
* {@inheritDoc} */
protected String getAuthorBlock( String author )
{
return null;
}
/** Not used.
* {@inheritDoc} */
protected String getBodyBlock()
{
return null;
}
/** {@inheritDoc} */
protected String getBoldBlock( String text )
{
return TWikiMarkup.BOLD_START_MARKUP + text + TWikiMarkup.BOLD_END_MARKUP;
}
/** Not used.
* {@inheritDoc} */
protected String getDateBlock( String date )
{
return null;
}
/** {@inheritDoc} */
protected String getDefinitionListBlock( String definum, String definition )
{
return TWikiMarkup.DEFINITION_LIST_ITEM_MARKUP + definum + TWikiMarkup.DEFINITION_LIST_DEFINITION_MARKUP
+ definition + EOL;
}
/** {@inheritDoc} */
protected String getFigureBlock( String source, String caption )
{
return "<img src=\"" + source + "\" alt=\"" + caption + "\" />";
}
/** Not used.
* {@inheritDoc} */
protected String getHeadBlock()
{
return null;
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return TWikiMarkup.HORIZONTAL_RULE_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getItalicBlock( String text )
{
return TWikiMarkup.ITALIC_START_MARKUP + text + TWikiMarkup.ITALIC_END_MARKUP;
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getLinkBlock( String link, String text )
{
return TWikiMarkup.LINK_START_MARKUP + link + TWikiMarkup.LINK_MIDDLE_MARKUP + text
+ TWikiMarkup.LINK_END_MARKUP;
}
/** {@inheritDoc} */
protected String getListBlock( String item )
{
return TWikiMarkup.LIST_ITEM_MARKUP + item + EOL;
}
/** {@inheritDoc} */
protected String getMonospacedBlock( String text )
{
return TWikiMarkup.MONOSPACED_START_MARKUP + text + TWikiMarkup.MONOSPACED_END_MARKUP;
}
/** {@inheritDoc} */
protected String getNonBreakingSpaceBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getNumberedListBlock( String item )
{
return TWikiMarkup.NUMBERING_LOWER_ROMAN_MARKUP + " " + item + EOL;
}
/** {@inheritDoc} */
protected String getPageBreakBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getParagraphBlock( String text )
{
return text + EOL + EOL;
}
/** {@inheritDoc} */
protected String getRawTextBlock( String text )
{
return "";
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return StringUtils.repeat( "-", 3 ) + StringUtils.repeat( "+", 1 ) + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return StringUtils.repeat( "-", 3 ) + StringUtils.repeat( "+", 2 ) + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection3Block( String title )
{
return StringUtils.repeat( "-", 3 ) + StringUtils.repeat( "+", 3 ) + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection4Block( String title )
{
return StringUtils.repeat( "-", 3 ) + StringUtils.repeat( "+", 4 ) + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection5Block( String title )
{
return StringUtils.repeat( "-", 3 ) + StringUtils.repeat( "+", 5 ) + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSectionTitleBlock( String title )
{
return title;
}
/** {@inheritDoc} */
protected String getTableBlock( String cell, String caption )
{
return "| " + cell + " |" + EOL + "Table_caption";
}
/** {@inheritDoc} */
protected String getTextBlock( String text )
{
return HtmlTools.escapeHTML( text );
}
/** Not used.
* {@inheritDoc} */
protected String getTitleBlock( String title )
{
return null;
}
/** {@inheritDoc} */
protected String getVerbatimBlock( String text )
{
return "<div class=\"source\">" + EOL + "<verbatim>" + text + "</verbatim>" + EOL + "</div>" + EOL;
}
/** {@inheritDoc} */
protected String outputExtension()
{
return "twiki";
}
// ----------------------------------------------------------------------
// Override unused tests
// ----------------------------------------------------------------------
/** Not used.
* {@inheritDoc} */
public void testAuthor()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testDate()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testHead()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testBody()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testTitle()
{
// nop
}
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
return "";
}
}
././@LongLink 0000000 0000000 0000000 00000000147 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/ doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000755 0001750 0001750 00000000000 11632765560 033440 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TitleTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000007177 11075462240 033444 0 ustar twerner twerner /*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.apache.maven.doxia.module.twiki.parser;
import java.io.StringReader;
import org.apache.maven.doxia.module.twiki.TWikiParser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
/**
* Tests for {@link TWikiParser#getTitle(java.util.List)}
*
*
* @author Juan F. Codagnone
* @since Nov 10, 2007
*/
public class TitleTest
extends AbstractBlockTestCase
{
public void testSectionTitle()
throws Exception
{
final ByLineSource source = new ByLineReaderSource( new StringReader( "---++ Test\n hello world" ) );
final TWikiParser parser = new TWikiParser();
assertEquals( "Test", parser.getTitle( parser.parse( source ), source ) );
}
public void testNoSectionTitle()
throws Exception
{
final ByLineSource source =
new NamedByLineSource( new ByLineReaderSource( new StringReader( "hello world" ) ), "testpage" );
final TWikiParser parser = new TWikiParser();
assertEquals( "testpage", parser.getTitle( parser.parse( source ), source ) );
}
public void testNoSectionTwikiExtensionTitle()
throws Exception
{
final ByLineSource source =
new NamedByLineSource( new ByLineReaderSource( new StringReader( "hello world" ) ), "testpage.twiki" );
final TWikiParser parser = new TWikiParser();
assertEquals( "testpage", parser.getTitle( parser.parse( source ), source ) );
}
}
class NamedByLineSource
implements ByLineSource
{
/** reader */
private final ByLineReaderSource reader;
/** reader's name */
private final String name;
public NamedByLineSource( final ByLineReaderSource reader, final String name )
{
if ( reader == null || name == null )
{
throw new IllegalArgumentException( "null arguments are not allowed" );
}
this.reader = reader;
this.name = name;
}
/** @see ByLineReaderSource#close() */
public final void close()
{
reader.close();
}
/** @see ByLineReaderSource#getLineNumber() */
public final int getLineNumber()
{
return reader.getLineNumber();
}
/** @see ByLineReaderSource#getName() */
public final String getName()
{
return name;
}
/** @see ByLineReaderSource#getNextLine() */
public final String getNextLine()
throws ParseException
{
return reader.getNextLine();
}
/** @see ByLineReaderSource#unget(java.lang.String) */
public final void unget( final String s )
throws IllegalStateException
{
reader.unget( s );
}
/** @see ByLineReaderSource#ungetLine() */
public final void ungetLine()
throws IllegalStateException
{
reader.ungetLine();
}
} ././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/BlockTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000012641 11123447331 033432 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Arrays;
import junit.framework.TestCase;
/**
* Generic unit tests for
* {@link Block}s
*
* @author Juan F. Codagnone
* @since Nov 2, 2005
*/
public class BlockTest
extends TestCase
{
/**
* @see TextBlock#equals(Object)
*/
public final void testTextBlockEquals()
{
testEquals( new TextBlock( "bar" ), new TextBlock( "bar" ), new TextBlock( "foo" ) );
}
/**
* @see WikiWordBlock#equals(Object)
*/
public final void testWikiWordBlockEquals()
{
final WikiWordLinkResolver resolver = new XHTMLWikiWordLinkResolver();
testEquals( new WikiWordBlock( "bar", resolver ), new WikiWordBlock( "bar", resolver ),
new WikiWordBlock( "foo", resolver ) );
testEquals( new WikiWordBlock( "bar", new TextBlock( "text" ), resolver ),
new WikiWordBlock( "bar", new TextBlock( "text" ), resolver ), new WikiWordBlock( "bar",
resolver ) );
testEquals( new WikiWordBlock( "bar", new TextBlock( "text" ), resolver ),
new WikiWordBlock( "bar", new TextBlock( "text" ), resolver ),
new WikiWordBlock( "text", new TextBlock( "bar" ), resolver ) );
}
/**
* @see LinkBlock#equals(Object)
*/
public final void testLinkBlockEquals()
{
testEquals( new LinkBlock( "foo", new TextBlock( "bar" ) ),
new LinkBlock( "foo", new TextBlock( "bar" ) ), new LinkBlock( "bar", new TextBlock( "foo" ) ) );
}
/**
* @see ListItemBlock#equals(Object)
*/
public final void testListBlockEquals()
{
final Block[] blocks = new Block[] { new TextBlock( "hello" ) };
testEquals( new ListItemBlock( blocks ), new ListItemBlock( blocks ), new ListItemBlock( new Block[] {} ) );
}
/**
* @see ListItemBlock#equals(Object)
*/
public final void testNestedBlockEquals()
{
testEquals( new ParagraphBlock( new Block[] { new BoldBlock( new Block[] { new TextBlock( "foo" ) } ) } ),
new ParagraphBlock( new Block[] { new BoldBlock( new Block[] { new TextBlock( "foo" ) } ) } ),
new ParagraphBlock( new Block[] { new BoldBlock( new Block[] { new TextBlock( "bar" ) } ) } ) );
}
/**
* @see AbstractFatherBlock#equals(Object)
*/
public final void testAbstractFatherBlockEquals()
{
assertFalse( Arrays
.equals(
new Block[] {
new TextBlock( "mary " ),
new ItalicBlock(
new Block[] { new MonospaceBlock(
new Block[] { new TextBlock(
"has" ) } ) } ) },
new Block[] {
new TextBlock( "mary " ),
new BoldBlock(
new Block[] { new MonospaceBlock(
new Block[] { new TextBlock(
"has" ) } ) } ) } ) );
}
/**
* @see AnchorBlock#equals(Object)
*/
public final void testAnchorBlockEquals()
{
testEquals( new AnchorBlock( "anchor" ), new AnchorBlock( "anchor" ), new AnchorBlock( "anch" ) );
}
/**
* @see HorizontalRuleBlock#equals(Object)
*/
public final void testHorizontalEquals()
{
testEquals( new HorizontalRuleBlock(), new HorizontalRuleBlock(), "foo" );
}
/**
* @param a an object
* @param b an object that is equals to a
* @param c a diferent object
*/
public final void testEquals( final Object a, final Object b, final Object c )
{
assertFalse( a.equals( null ) );
assertFalse( b.equals( null ) );
assertFalse( c.equals( null ) );
assertNotSame( a, b );
assertEquals( a, a );
assertEquals( b, b );
assertEquals( c, c );
assertEquals( a, b );
assertEquals( b, a );
assertFalse( a.equals( c ) );
assertEquals( a.hashCode(), b.hashCode() );
}
}
././@LongLink 0000000 0000000 0000000 00000000164 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/ListTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000012223 11123447331 033426 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
/**
* Units tests for Lists
*
* @author Juan F. Codagnone
* @since Nov 1, 2005
*/
public class ListTest
extends AbstractBlockTestCase
{
/**
* unit test for recurrent enumeration
*
* @throws ParseException on error
*/
public final void testList()
throws ParseException
{
final BlockParser parser = listParser;
final String text =
"" + " * item1.1 \n" + " * item2\n" + " * item2.1\n" + " * item3\n"
+ " * item3.1\n" + " * item3.2\n" + " * item3.2.1\n" + " * item3.2.2\n"
+ " * item3.2.3\n" + " * item3.3\n" + " * item3.3.1\n" + " * item4";
final ByLineSource source = new ByLineReaderSource( new StringReader( text ) );
final Block b = parser.visit( source.getNextLine(), source );
final Block[] firstLevelBlocks = ( (UnorderedListBlock) b ).getBlocks();
final int numberOfChild = 4;
assertEquals( numberOfChild, firstLevelBlocks.length );
for ( int i = 0; i < firstLevelBlocks.length; i++ )
{
Block block = firstLevelBlocks[i];
assertEquals( ListItemBlock.class, block.getClass() );
}
ListBlock list;
ListItemBlock item;
Block[] blocks;
item = (ListItemBlock) firstLevelBlocks[1];
blocks = item.getBlocks();
assertEquals( 1, blocks.length );
assertEquals( "item2", ( (TextBlock) blocks[0] ).getText() );
list = item.getInnerList();
assertNotNull( list );
blocks = list.getBlocks();
assertEquals( blocks.length, 1 );
item = (ListItemBlock) blocks[0];
assertEquals( 1, item.getBlocks().length );
assertEquals( "item2.1", ( (TextBlock) item.getBlocks()[0] ).getText() );
}
/**
* @throws ParseException on error
*/
public final void testNumeringDecimal()
throws ParseException
{
final String text = "" + " 1. item1\n" + " 1. item2\n" + " 1. item3";
final ByLineSource source = new ByLineReaderSource( new StringReader( text ) );
Block blocks, expected;
expected =
new NumeratedListBlock( Sink.NUMBERING_DECIMAL, new ListItemBlock[] {
new ListItemBlock( new Block[] { new TextBlock( "item1" ) } ),
new ListItemBlock( new Block[] { new TextBlock( "item2" ) } ),
new ListItemBlock( new Block[] { new TextBlock( "item3" ) } ) } );
blocks = listParser.visit( source.getNextLine(), source );
assertEquals( expected, blocks );
}
/**
* @throws ParseException on error
*/
public final void testHetero()
throws ParseException
{
final String text =
"" + " A. item1\n" + " * item1.1\n" + " * item1.2\n" + " B. item2\n"
+ " i. item2.1\n" + " i. item2.2\n" + " C. item3";
final ByLineSource source = new ByLineReaderSource( new StringReader( text ) );
Block blocks, expected;
expected =
new NumeratedListBlock( Sink.NUMBERING_UPPER_ALPHA, new ListItemBlock[] {
new ListItemBlock( new Block[] { new TextBlock( "item1" ) },
new UnorderedListBlock( new ListItemBlock[] {
new ListItemBlock( new Block[] { new TextBlock( "item1.1" ) } ),
new ListItemBlock( new Block[] { new TextBlock( "item1.2" ) } ) } ) ),
new ListItemBlock( new Block[] { new TextBlock( "item2" ) },
new NumeratedListBlock( Sink.NUMBERING_LOWER_ROMAN, new ListItemBlock[] {
new ListItemBlock( new Block[] { new TextBlock( "item2.1" ) } ),
new ListItemBlock( new Block[] { new TextBlock( "item2.2" ) } ) } ) ),
new ListItemBlock( new Block[] { new TextBlock( "item3" ) } ) } );
blocks = listParser.visit( source.getNextLine(), source );
assertEquals( expected, blocks );
}
}
././@LongLink 0000000 0000000 0000000 00000000174 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000017224 11123447331 033434 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Arrays;
/**
* Tests the {@link org.apache.maven.doxia.module.twiki.parser.FormatedTextParser}
*
* @author Juan F. Codagnone
* @since Nov 2, 2005
*/
public class FormatedTextTest
extends AbstractBlockTestCase
{
/**
* test bold text
*/
public final void testBold()
{
String text;
Block[] blocks;
text = "*bold*";
blocks = formatTextParser.parse( text );
assertEquals( 1, blocks.length );
assertEquals( new BoldBlock( new Block[] { new TextBlock( "bold" ) } ), blocks[0] );
text = "foo *bold* bar";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new TextBlock( "foo " ),
new BoldBlock( new Block[] { new TextBlock( "bold" ) } ), new TextBlock( " bar" ) }, blocks ) );
text = "\t*bold* bar";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new TextBlock( "\t" ),
new BoldBlock( new Block[] { new TextBlock( "bold" ) } ), new TextBlock( " bar" ) }, blocks ) );
text = "*nice* foo *bold* bar";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new BoldBlock( new Block[] { new TextBlock( "nice" ) } ),
new TextBlock( " foo " ), new BoldBlock( new Block[] { new TextBlock( "bold" ) } ),
new TextBlock( " bar" ) }, blocks ) );
}
/**
* test italic text
*/
public final void testItalic()
{
String text;
Block[] blocks;
text = "_italic_";
blocks = formatTextParser.parse( text );
assertEquals( 1, blocks.length );
assertEquals( new ItalicBlock( new Block[] { new TextBlock( "italic" ) } ), blocks[0] );
text = "foo _italic_ bar";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new TextBlock( "foo " ),
new ItalicBlock( new Block[] { new TextBlock( "italic" ) } ), new TextBlock( " bar" ) }, blocks ) );
text = "_nice_ foo _italic_ bar";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new ItalicBlock( new Block[] { new TextBlock( "nice" ) } ),
new TextBlock( " foo " ), new ItalicBlock( new Block[] { new TextBlock( "italic" ) } ),
new TextBlock( " bar" ) }, blocks ) );
}
/**
* test monospaced text
*/
public final void testMonospaced()
{
String text;
Block[] blocks;
text = "mary =has= a =little= lamb He followed her (=to school one day=)";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new TextBlock( "mary " ),
new MonospaceBlock( new Block[] { new TextBlock( "has" ) } ), new TextBlock( " a " ),
new MonospaceBlock( new Block[] { new TextBlock( "little" ) } ),
new TextBlock( " lamb He followed her (" ),
new MonospaceBlock( new Block[] { new TextBlock( "to school one day" ) } ), new TextBlock( ")" ) },
blocks ) );
}
/**
* test monospaced text
*/
public final void testBoldMonospaced()
{
String text;
Block[] blocks;
text = "mary ==has== a ==little== lamb";
blocks = formatTextParser.parse( text );
Block[] expected =
new Block[] { new TextBlock( "mary " ),
new BoldBlock( new Block[] { new MonospaceBlock( new Block[] { new TextBlock( "has" ) } ) } ),
new TextBlock( " a " ),
new BoldBlock( new Block[] { new MonospaceBlock( new Block[] { new TextBlock( "little" ) } ) } ),
new TextBlock( " lamb" ) };
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* test monospaced text
*/
public final void testBoldItalic()
{
String text;
Block[] blocks;
text = "mary __has__ a __little__ lamb";
blocks = formatTextParser.parse( text );
assertTrue( Arrays.equals( new Block[] { new TextBlock( "mary " ),
new BoldBlock( new Block[] { new ItalicBlock( new Block[] { new TextBlock( "has" ) } ) } ),
new TextBlock( " a " ),
new BoldBlock( new Block[] { new ItalicBlock( new Block[] { new TextBlock( "little" ) } ) } ),
new TextBlock( " lamb" ) }, blocks ) );
}
/**
* test mixed formats side by side
*/
public final void testMultiFormatSideBySide()
{
String text;
Block[] blocks;
Block[] expected;
text = "All *work and* =no play= _makes_ Juan a dull *boy*";
blocks = formatTextParser.parse( text );
expected =
new Block[] { new TextBlock( "All " ), new BoldBlock( new Block[] { new TextBlock( "work and" ) } ),
new TextBlock( " " ), new MonospaceBlock( new Block[] { new TextBlock( "no play" ) } ),
new TextBlock( " " ), new ItalicBlock( new Block[] { new TextBlock( "makes" ) } ),
new TextBlock( " Juan a dull " ), new BoldBlock( new Block[] { new TextBlock( "boy" ) } ) };
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* test mixed formats recursevily
*/
public final void testMultiFormatInside()
{
String text;
Block[] blocks;
Block[] expected;
text = "All *work and =no play _makes_ Juan= a dull* boy";
blocks = formatTextParser.parse( text );
expected =
new Block[] {
new TextBlock( "All " ),
new BoldBlock(
new Block[] {
new TextBlock( "work and " ),
new MonospaceBlock( new Block[] { new TextBlock( "no play " ),
new ItalicBlock( new Block[] { new TextBlock( "makes" ) } ),
new TextBlock( " Juan" ) } ), new TextBlock( " a dull" ) } ),
new TextBlock( " boy" ) };
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* test unbonded formats
*/
public final void testUnboundedFormat()
{
testHanging( "All *work and no play makes Juan a dull boy" );
testHanging( "All __work and no play makes Juan a dull boy" );
testHanging( "All __work and *no play makes _Juan a = dull boy" );
testHanging( "*" );
testHanging( "==" );
testHanging( "**" ); // hehe
testHanging( "* hello *" );
testHanging( "* hello =*" );
testHanging( "*=_ hello _=*" );
}
/**
* @param text unbonded text
*/
public final void testHanging( final String text )
{
assertTrue( Arrays.equals( new Block[] { new TextBlock( text ) }, formatTextParser.parse( text ) ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/TableTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000006010 11123447331 033423 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Tests the {@link org.apache.maven.doxia.module.twiki.parser.TableBlockParser}
*
* @author Juan F. Codagnone
* @since Nov 9, 2005
*/
public class TableTest
extends AbstractBlockTestCase
{
/**
* unit test the regex
*/
public final void testRegex()
{
assertTrue( tableParser.accept( " | cell1 | cell2| " ) );
assertFalse( tableParser.accept( " | cell1 | cell" ) );
}
/**
* @throws ParseException on error
*/
public final void testTable()
throws ParseException
{
final StringReader sw = new StringReader( "" + " |cell1|cell2| \n" + "|cell3|cell4|\n" );
final ByLineSource source = new ByLineReaderSource( sw );
Block block, expected;
expected =
new TableBlock( new Block[] {
new TableRowBlock( new Block[] { new TableCellBlock( new Block[] { new TextBlock( "cell1" ) } ),
new TableCellBlock( new Block[] { new TextBlock( "cell2" ) } ) } ),
new TableRowBlock( new Block[] { new TableCellBlock( new Block[] { new TextBlock( "cell3" ) } ),
new TableCellBlock( new Block[] { new TextBlock( "cell4" ) } ) } ) } );
block = tableParser.visit( source.getNextLine(), source );
assertEquals( block, expected );
}
/**
* @throws ParseException on error
*/
public final void testTableHeader()
throws ParseException
{
final StringReader sw = new StringReader( "|*cell1*|*cell2*|\n" );
final ByLineSource source = new ByLineReaderSource( sw );
Block block, expected;
expected =
new TableBlock( new Block[] { new TableRowBlock( new Block[] {
new TableCellHeaderBlock( new Block[] { new TextBlock( "cell1" ) } ),
new TableCellHeaderBlock( new Block[] { new TextBlock( "cell2" ) } ) } ) } );
block = tableParser.visit( source.getNextLine(), source );
assertEquals( block, expected );
}
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/WordsTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000030476 11123447331 033440 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Arrays;
/**
* tests the WikiWord parsing (and things like that)
*
* @author Juan F. Codagnone
* @since Nov 4, 2005
*/
public class WordsTest
extends AbstractBlockTestCase
{
/**
* used to convert lists to arrays
*/
private static final Block[] TOARRAY = new Block[] {};
/**
* Resolves links for wikiWords
*/
private final WikiWordLinkResolver resolver = new XHTMLWikiWordLinkResolver();
/**
* ...
*/
public final void testText()
{
Block[] blocks, expected;
expected = new Block[] { new TextBlock( " Some text " ) };
blocks = (Block[]) textParser.parse( " Some text " ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ...
*/
public final void testWikiWords()
{
Block[] blocks, expected;
expected = new Block[] { new WikiWordBlock( "WikiWord", resolver ) };
blocks = (Block[]) textParser.parse( "WikiWord" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
// this is not a wiki word
expected = new Block[] { new TextBlock( "Wiki" ) };
blocks = (Block[]) textParser.parse( "Wiki" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new TextBlock( "Web." ) };
blocks = (Block[]) textParser.parse( "Web." ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new TextBlock( "fooWikiBar" ) };
blocks = (Block[]) textParser.parse( "fooWikiBar" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new WikiWordBlock( "WikiWord", resolver ), new TextBlock( "...." ) };
blocks = (Block[]) textParser.parse( "WikiWord...." ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ...
*/
public final void testWebWikiWords()
{
Block[] blocks, expected;
expected = new Block[] { new WikiWordBlock( "Web.WikiWord", resolver ) };
blocks = (Block[]) textParser.parse( "Web.WikiWord" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new WikiWordBlock( "My1Web.WikiWord", resolver ) };
blocks = (Block[]) textParser.parse( "My1Web.WikiWord" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ...
*/
public final void testWebAnchorWikiWords()
{
Block[] blocks, expected;
expected = new Block[] { new WikiWordBlock( "WikiWord#anchor", resolver ) };
blocks = (Block[]) textParser.parse( "WikiWord#anchor" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new WikiWordBlock( "MyWeb.WikiWord#anchor", resolver ) };
blocks = (Block[]) textParser.parse( "MyWeb.WikiWord#anchor" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* test Specific Links
*/
public final void testURLSpecificLinks()
{
Block[] blocks, expected;
expected = new Block[] { new LinkBlock( "http://reference.com", new TextBlock( "text" ) ) };
blocks = (Block[]) textParser.parse( "[[http://reference.com][text]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( "foo" ),
new LinkBlock( "http://reference.com", new TextBlock( "text" ) ), new TextBlock( "bar" ) };
blocks = (Block[]) textParser.parse( "foo[[http://reference.com][text]]bar" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( " foo " ),
new LinkBlock( "http://reference.com", new TextBlock( "text" ) ), new TextBlock( " bar " ) };
blocks = (Block[]) textParser.parse( " foo [[http://reference.com][text]] bar " ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] {
new LinkBlock( "http://www.apache.org/licenses/LICENSE-2.0",
new TextBlock( "Apache License, version 2.0" ) ),
new TextBlock( ". You can download it " ),
new WikiWordBlock( "DoxiaDownload", new TextBlock( "here" ), resolver ) };
blocks =
(Block[]) textParser.parse(
"[[http://www.apache.org/licenses/LICENSE-2.0]"
+ "[Apache License, version 2.0]]. You can download it "
+ "[[DoxiaDownload][here]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* test Specific Links with wikiWords
*/
public final void testWikiSpecificLinks()
{
Block[] blocks, expected;
expected = new Block[] { new WikiWordBlock( "Reference", new TextBlock( "text" ), resolver ) };
blocks = (Block[]) textParser.parse( "[[reference][text]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( "foo" ),
new WikiWordBlock( "ReferenceLink", new TextBlock( "text" ), resolver ), new TextBlock( "bar" ) };
blocks = (Block[]) textParser.parse( "foo[[referenceLink][text]]bar" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( " foo " ),
new WikiWordBlock( "ReferenceLink", new TextBlock( "text" ), resolver ), new TextBlock( " bar " ) };
blocks = (Block[]) textParser.parse( " foo [[reference link][text]] bar " ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* test Specific Links
*/
public final void testSpecificLinkPrevention()
{
Block[] blocks, expected;
expected = new Block[] { new TextBlock( "[[reference][text]]" ) };
blocks = (Block[]) textParser.parse( "![[reference][text]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ...
*/
public final void testPreventLinkingWikiWord()
{
Block[] blocks, expected;
expected = new Block[] { new TextBlock( " " ), new TextBlock( "WikiWord" ), new TextBlock( " " ) };
blocks = (Block[]) textParser.parse( " !WikiWord " ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new TextBlock( " !!WikiWord " ) };
blocks = (Block[]) textParser.parse( " !!WikiWord " ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ej [[Main.TWiki rules]] would be wikiword Main.TWikiRules
*/
public final void testForcedLinks()
{
Block[] blocks, expected;
expected = new Block[] { new WikiWordBlock( "WikiSyntax", new TextBlock( "wiki syntax" ), resolver ) };
blocks = (Block[]) textParser.parse( "[[wiki syntax]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new TextBlock( "[[wiki syntax]]" ) };
blocks = (Block[]) textParser.parse( "![[wiki syntax]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( "foo" ),
new WikiWordBlock( "WikiSyntax", new TextBlock( "wiki syntax" ), resolver ),
new TextBlock( "bar" ) };
blocks = (Block[]) textParser.parse( "foo[[wiki syntax]]bar" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( "foo" ),
new LinkBlock( "http://twiki.com", new TextBlock( "http://twiki.com" ) ), new TextBlock( "bar" ) };
blocks = (Block[]) textParser.parse( "foo[[http://twiki.com]]bar" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ...
*/
public final void testMailtoForcedLinks()
{
Block[] blocks, expected;
expected = new Block[] { new LinkBlock( "mailto:a@z.com", new TextBlock( "Mail" ) ) };
blocks = (Block[]) textParser.parse( "[[mailto:a@z.com Mail]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* ...
*/
public final void testAnchors()
{
Block[] blocks, expected;
expected = new Block[] { new TextBlock( "mary has #anchor a little lamb" ) };
blocks = (Block[]) textParser.parse( "mary has #anchor a little lamb" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected =
new Block[] { new TextBlock( "mary has " ), new AnchorBlock( "AnchorName" ),
new TextBlock( " a little lamb" ) };
blocks = (Block[]) textParser.parse( "mary has #AnchorName a little lamb" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
expected = new Block[] { new TextBlock( "mary has #AnchorName1233 a little lamb" ) };
blocks = (Block[]) textParser.parse( "mary has #AnchorName1233 a little lamb" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* unit test
*/
public final void testAutomaticLink()
{
Block[] blocks, expected;
expected =
new Block[] { new TextBlock( "Go to " ),
new LinkBlock( "http://twiki.com", new TextBlock( "http://twiki.com" ) ),
new TextBlock( " and ..." ) };
blocks = (Block[]) textParser.parse( "Go to http://twiki.com and ..." ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/** unit test */
public final void testAutomaticImage()
{
Block[] blocks, expected;
expected =
new Block[] { new LinkBlock( "http://twiki.org", new ImageBlock( "http://twiki.org/logo.png" ) ) };
blocks = (Block[]) textParser.parse( "[[http://twiki.org][http://twiki.org/logo.png]]" ).toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/** unit test */
public final void testLinkImage()
{
Block[] blocks, expected;
expected =
new Block[] { new TextBlock( "Go to " ), new ImageBlock( "http://twiki.com/image.png" ),
new TextBlock( " thisisnotanimage.png and ..." ) };
blocks =
(Block[]) textParser.parse( "Go to http://twiki.com/image.png " + "thisisnotanimage.png and ..." )
.toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
/**
* Test image inserted with a html img tag
*/
public final void testRelativeImage()
{
Block[] blocks, expected;
expected =
new Block[] { new TextBlock( "My summer house: " ), new ImageBlock( "images/summerhouse.png" ),
new TextBlock( " isn't it great?!" ) };
blocks =
(Block[]) textParser
.parse(
"My summer house: <img class=\"some_class\" src=\"images/summerhouse.png\"/> isn't it great?!" )
.toArray( TOARRAY );
assertTrue( Arrays.equals( expected, blocks ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/AbstractBlockTestCase.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000006474 11075462240 033443 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import junit.framework.TestCase;
import org.apache.maven.doxia.module.twiki.TWikiParser;
/**
* Common code to the Block unit tests
*
* @author Juan F. Codagnone
* @since Nov 1, 2005
*/
public abstract class AbstractBlockTestCase
extends TestCase
{
/**
* sectionParser to use in all the tests
*/
protected final SectionBlockParser sectionParser = new SectionBlockParser();
/**
* ParagraphBlockParser to use in all the tests
*/
protected final ParagraphBlockParser paraParser = new ParagraphBlockParser();
/**
* ListBlockParser used in all the tests
*/
protected final GenericListBlockParser listParser = new GenericListBlockParser();
/**
* FormatedTextParser used in all the tests
*/
protected final FormatedTextParser formatTextParser = new FormatedTextParser();
/**
* TextParser used in all the tests
*/
protected final TextParser textParser = new TextParser( new XHTMLWikiWordLinkResolver() );
/**
* TextParser used in all the tests
*/
protected final HRuleBlockParser hruleParser = new HRuleBlockParser();
/**
* TableBlockParser used in all the tests
*/
protected final TableBlockParser tableParser = new TableBlockParser();
/**
* TWiki used in all the tests
*/
protected final TWikiParser twikiParser = new TWikiParser();
/**
* Parser for verbatim blocks
*/
private final VerbatimBlockParser verbatimParser = new VerbatimBlockParser();
/**
* Creates the AbstractBlockTestCase.
*/
public AbstractBlockTestCase()
{
sectionParser.setParaParser( paraParser );
sectionParser.setHrulerParser( hruleParser );
paraParser.setSectionParser( sectionParser );
paraParser.setListParser( listParser );
paraParser.setTextParser( formatTextParser );
paraParser.setHrulerParser( hruleParser );
paraParser.setTableBlockParser( tableParser );
paraParser.setVerbatimParser( verbatimParser );
sectionParser.setVerbatimBlockParser( new VerbatimBlockParser() );
listParser.setTextParser( formatTextParser );
formatTextParser.setTextParser( textParser );
tableParser.setTextParser( formatTextParser );
}
/**
* Returns the verbatimParser.
*
* @return <code>VerbatimBlockParser</code> with the verbatimParser.
*/
protected final VerbatimBlockParser getVerbatimParser()
{
return verbatimParser;
}
}
././@LongLink 0000000 0000000 0000000 00000000167 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/SectionTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000014170 11123447331 033431 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import java.util.Arrays;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Tests the {@link org.apache.maven.doxia.module.twiki.parser.SectionBlockParser}
*
* @author Juan F. Codagnone
* @since Nov 1, 2005
*/
public class SectionTest
extends AbstractBlockTestCase
{
/**
* @see SectionBlock#SectionBlock(String, int, Block[])
*/
public final void testSectionBlockWrongArgs()
{
final int maxLevel = 5;
new SectionBlock( "hola", 1, new Block[] {} );
new SectionBlock( "hola", maxLevel, new Block[] {} );
try
{
new SectionBlock( "hola", maxLevel + 1, new Block[] {} );
fail();
}
catch ( final Throwable e )
{
// ok
}
try
{
new SectionBlock( "hola", 0, new Block[] {} );
fail();
}
catch ( final Throwable e )
{
// ok
}
try
{
new SectionBlock( null, 1, null );
fail();
}
catch ( final Throwable e )
{
// ok
}
new SectionBlock( "", 1, new Block[] {} );
}
/**
* @see SectionBlockParser#getLevel(String)
*/
public final void testSectionParserGetLevel()
{
assertEquals( 2, SectionBlockParser.getLevel( "++" ) );
try
{
SectionBlockParser.getLevel( "asdasd" );
fail( "expected exception was not thrown" );
}
catch ( IllegalArgumentException e )
{
// ok
}
}
/**
* @throws java.lang.Exception
* @see SectionBlockParser
*/
public final void testSectionParser()
throws Exception
{
final SectionBlockParser parser = sectionParser;
assertTrue( parser.accept( "---+ Title1" ) );
assertTrue( parser.accept( "---++ Title2" ) );
assertFalse( parser.accept( " ---++ Title3" ) );
assertTrue( parser.accept( "---+++ Title4" ) );
assertTrue( parser.accept( "---++++ Title5" ) );
assertTrue( parser.accept( "---+++++ Title6" ) );
SectionBlock block;
block = (SectionBlock) parser.visit( "---++++ Title4", new ByLineReaderSource( new StringReader( "" ) ) );
final int level = 4;
assertEquals( "Title4", block.getTitle() );
assertEquals( level, block.getLevel() );
assertEquals( 0, block.getBlocks().length );
// ejemplo un poco m�s complejo
block =
(SectionBlock) parser.visit( "---+++ Title3",
new ByLineReaderSource( new StringReader(
"This is *a* parragraph of a section.\n"
+ "Some text.\n"
+ "---+++ Another Title"
+ "... and more text" ) ) );
final SectionBlock expected =
new SectionBlock( "Title3", 3, new Block[] { new ParagraphBlock( new Block[] {
new TextBlock( "This is " ), new BoldBlock( new Block[] { new TextBlock( "a" ) } ),
new TextBlock( " parragraph of a section. Some text." ) } ) } );
assertEquals( expected, block );
}
/**
* Test section with several paragraphs (the paragraph are plain text)
*
* @throws Exception on error
*/
public final void testSectionWithParagraphs()
throws Exception
{
final String text =
"" + "---++ Title\n" + "\n" + "hey!\n" + "how are\n" + "you?\n" + " \n " + "Fine!! thanks";
final SectionBlockParser parser = sectionParser;
parser.setVerbatimBlockParser( new VerbatimBlockParser() );
final ByLineReaderSource source = new ByLineReaderSource( new StringReader( text ) );
final SectionBlock block = (SectionBlock) parser.visit( source.getNextLine(), source );
assertEquals( 2, block.getBlocks().length );
assertEquals( "hey! how are you?",
( (TextBlock) ( (ParagraphBlock) block.getBlocks()[0] ).getBlocks()[0] ).getText() );
assertEquals( "Fine!! thanks",
( (TextBlock) ( (ParagraphBlock) block.getBlocks()[1] ).getBlocks()[0] ).getText() );
}
/**
* @throws ParseException on error
*/
public final void testSectionAndParaAndHrule()
throws ParseException
{
Block[] blocks, expected;
ByLineReaderSource source;
source =
new ByLineReaderSource( new StringReader( "" + "---++ Title\n" + "Some text\n"
+ "----------- More text\n" ) );
expected =
new Block[] { new SectionBlock( "Title", 1, new Block[] {
new ParagraphBlock( new Block[] { new TextBlock( "Some text" ) } ), new HorizontalRuleBlock(),
new ParagraphBlock( new Block[] { new TextBlock( "More text" ) } ) } ) };
blocks = (Block[]) twikiParser.parse( source ).toArray( new Block[] {} );
assertTrue( Arrays.equals( expected, blocks ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000171 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/ParagraphTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000015321 11123447331 033430 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import java.util.Arrays;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Tests the {@link org.apache.maven.doxia.module.twiki.parser.ParagraphBlockParser}
*
* @author Juan F. Codagnone
* @since Nov 1, 2005
*/
public class ParagraphTest
extends AbstractBlockTestCase
{
/**
* @throws ParseException on error
*/
public final void testMultiLines()
throws ParseException
{
final String text =
"" + "\n\n\n" + "para1 -> text1\n" + "para1 -> text2\n" + "\n" + "para2 -> text1\n"
+ "para2 -> text2\n" + " \n \n " + "para2 -> text1\n" + "para2 -> text2\n";
final ByLineReaderSource source = new ByLineReaderSource( new StringReader( text ) );
final ParagraphBlockParser parser = paraParser;
ParagraphBlock block;
block = (ParagraphBlock) parser.visit( source.getNextLine(), source );
assertNotNull( block );
assertEquals( 1, block.getBlocks().length );
assertEquals( "para1 -> text1 para1 -> text2", ( (TextBlock) block.getBlocks()[0] ).getText() );
block = (ParagraphBlock) parser.visit( source.getNextLine(), source );
assertNotNull( block );
assertEquals( 1, block.getBlocks().length );
assertEquals( "para2 -> text1 para2 -> text2", ( (TextBlock) block.getBlocks()[0] ).getText() );
}
/**
* @throws ParseException on error
*/
public final void testParagraphWithList()
throws ParseException
{
final String text =
"" + "Description text:\n" + " * item1\n" + " * item2\n"
+ "This is more text in the same paragraph\n" + "\n" + "Another paragraph";
final ByLineReaderSource source = new ByLineReaderSource( new StringReader( text ) );
final ParagraphBlockParser parser = paraParser;
ParagraphBlock block;
block = (ParagraphBlock) parser.visit( source.getNextLine(), source );
assertNotNull( block );
final Block[] firstLevelChilds = block.getBlocks();
final int numberOfChilds = 3;
assertEquals( numberOfChilds, firstLevelChilds.length );
assertEquals( TextBlock.class, firstLevelChilds[0].getClass() );
assertEquals( UnorderedListBlock.class, firstLevelChilds[1].getClass() );
assertEquals( TextBlock.class, firstLevelChilds[2].getClass() );
final Block[] listChilds = ( (UnorderedListBlock) firstLevelChilds[1] ).getBlocks();
assertEquals( 2, listChilds.length );
assertEquals( 1, ( (ListItemBlock) listChilds[0] ).getBlocks().length );
assertEquals( "item1", ( (TextBlock) ( (ListItemBlock) listChilds[0] ).getBlocks()[0] ).getText() );
assertEquals( "item2", ( (TextBlock) ( (ListItemBlock) listChilds[1] ).getBlocks()[0] ).getText() );
}
/**
* tests some valid weired lists
*
* @throws ParseException on error
*/
public final void testParagraphWithStartingList()
throws ParseException
{
final String text =
"" + " * item1\n" + " * item2\n" + "This is more text in the same paragraph\n" + "\n"
+ "Another paragraph";
final ByLineReaderSource source = new ByLineReaderSource( new StringReader( text ) );
final ParagraphBlockParser parser = paraParser;
ParagraphBlock block;
block = (ParagraphBlock) parser.visit( source.getNextLine(), source );
assertNotNull( block );
final Block[] firstLevelChilds = block.getBlocks();
assertEquals( 2, firstLevelChilds.length );
assertEquals( UnorderedListBlock.class, firstLevelChilds[0].getClass() );
assertEquals( TextBlock.class, firstLevelChilds[1].getClass() );
final Block[] listChilds = ( (UnorderedListBlock) firstLevelChilds[0] ).getBlocks();
assertEquals( 2, listChilds.length );
assertEquals( 1, ( (ListItemBlock) listChilds[0] ).getBlocks().length );
assertEquals( "item1", ( (TextBlock) ( (ListItemBlock) listChilds[0] ).getBlocks()[0] ).getText() );
assertEquals( "item2", ( (TextBlock) ( (ListItemBlock) listChilds[1] ).getBlocks()[0] ).getText() );
}
/**
* @throws ParseException on error
*/
public final void testHorizontalRule()
throws ParseException
{
Block block, expected;
ByLineReaderSource source;
assertTrue( hruleParser.accept( "---" ) );
assertFalse( hruleParser.accept( "---+ asdas" ) );
source = new ByLineReaderSource( new StringReader( "" ) );
expected = new HorizontalRuleBlock();
block = hruleParser.visit( "---", source );
assertNull( source.getNextLine() );
assertEquals( expected, block );
source = new ByLineReaderSource( new StringReader( "" ) );
expected = new HorizontalRuleBlock();
block = hruleParser.visit( "--- Some text ---- And some more", source );
assertEquals( expected, block );
expected = new ParagraphBlock( new Block[] { new TextBlock( "Some text ---- And some more" ) } );
block = paraParser.visit( source.getNextLine(), source );
assertEquals( expected, block );
}
/**
* @throws ParseException on error
*/
public final void testHorizontalRuleAndParagraph()
throws ParseException
{
Block[] blocks, expected;
ByLineReaderSource source;
source = new ByLineReaderSource( new StringReader( "" + "Some text\n" + "-----------\n" + "More text" ) );
expected =
new Block[] { new ParagraphBlock( new Block[] { new TextBlock( "Some text" ) } ),
new HorizontalRuleBlock(), new ParagraphBlock( new Block[] { new TextBlock( "More text" ) } ) };
blocks = (Block[]) twikiParser.parse( source ).toArray( new Block[] {} );
assertTrue( Arrays.equals( expected, blocks ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000170 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parser/VerbatimTest.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/test/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000010135 11123447331 033426 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
import java.io.StringReader;
import java.util.Arrays;
import java.util.List;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Tests the {@link org.apache.maven.doxia.module.twiki.parser.VerbatimBlock}
*
* @author Christian Nardi
* @since Nov 8, 2007
*/
public class VerbatimTest
extends AbstractBlockTestCase
{
/**
* unit test the regex
*/
public final void testRegex()
{
assertTrue( getVerbatimParser().accept( "<verbatim>" ) );
assertTrue( getVerbatimParser().accept( " <verbatim>" ) );
assertTrue( getVerbatimParser().accept( "<verbatim> a word" ) );
assertTrue( getVerbatimParser().accept( "<verbatim> another Word" ) );
}
/**
* @throws ParseException if the parser does not accept the line
*
*/
public void testVerbatim()
throws ParseException
{
final StringReader sw =
new StringReader( "" + " <verbatim> hello, \n" + " this is a verbatim text \n"
+ " which i would like to test \n" + " Thanks </verbatim>" );
final ByLineSource source = new ByLineReaderSource( sw );
Block block, expected;
expected =
new VerbatimBlock( new Block[] { new TextBlock( " hello, \n" ),
new TextBlock( " this is a verbatim text \n" ), new TextBlock( " which i would like to test \n" ),
new TextBlock( " Thanks \n" ) } );
block = getVerbatimParser().visit( source.getNextLine(), source );
assertEquals( block, expected );
}
/**
* @throws Exception .
*/
public void testTwiki()
throws Exception
{
final StringReader sw =
new StringReader( "hello this is a paragraph \n" + " <verbatim> hello, \n"
+ " this is a verbatim text \n" + " which i would like to test \n" + " Thanks </verbatim>" );
final ByLineSource source = new ByLineReaderSource( sw );
Block[] expected;
expected =
new Block[] {
new ParagraphBlock( new Block[] { new TextBlock( "hello this is a paragraph" ) } ),
new VerbatimBlock( new Block[] { new TextBlock( " hello, \n" ),
new TextBlock( " this is a verbatim text \n" ),
new TextBlock( " which i would like to test \n" ), new TextBlock( " Thanks \n" ) } ) };
List block = twikiParser.parse( source );
assertTrue( Arrays.equals( block.toArray(), expected ) );
}
/** test
* @throws org.apache.maven.doxia.parser.ParseException
*/
public void testVerbatimAfterSection()
throws ParseException
{
final StringReader sw =
new StringReader( "---++ fooo\n" + " <verbatim> hello, \n" + " Thanks </verbatim>" );
final ByLineSource source = new ByLineReaderSource( sw );
Block[] expected;
expected =
new Block[] { new SectionBlock( "foo", 2, new Block[] { new VerbatimBlock( new Block[] {
new TextBlock( " hello, \n" ), new TextBlock( " Thanks \n" ) } ) } ) };
List block = twikiParser.parse( source );
assertTrue( Arrays.equals( block.toArray(), expected ) );
}
}
doxia-1.1.4/doxia-modules/doxia-module-twiki/src/site/ 0000755 0001750 0001750 00000000000 11632765560 022613 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 024265 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
-->
<project>
<body>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project> doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/ 0000755 0001750 0001750 00000000000 11632765560 022573 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/ 0000755 0001750 0001750 00000000000 11632765560 023514 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765560 024303 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765560 025524 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765560 026632 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765560 027736 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765560 031223 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/ 0000755 0001750 0001750 00000000000 11632765560 032352 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSinkFactory.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWiki0000644 0001750 0001750 00000003075 11105660512 033313 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractTextSinkFactory;
import org.apache.maven.doxia.sink.Sink;
/**
* TWiki implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: TWikiSinkFactory.java 712574 2008-11-09 22:16:42Z hboutemy $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="twiki"
*/
public class TWikiSinkFactory
extends AbstractTextSinkFactory
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding )
{
// encoding can safely be ignored since it isn't written into the generated TWiki source
return new TWikiSink( writer );
}
}
././@LongLink 0000000 0000000 0000000 00000000164 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSiteModule.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWiki0000644 0001750 0001750 00000002527 11212745470 033322 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
* <p>TWikiSiteModule class.</p>
*
* @author Juan F. Codagnone
* @version $Id: TWikiSiteModule.java 782392 2009-06-07 14:14:16Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="twiki"
*/
public class TWikiSiteModule
extends AbstractSiteModule
{
/**
* Default constructor.
*/
public TWikiSiteModule()
{
super( "twiki", "twiki", "twiki" );
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiSink.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWiki0000644 0001750 0001750 00000062434 11244502706 033323 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Stack;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.html.HTML.Attribute;
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.sink.AbstractTextSink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.SinkUtils;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
/**
* TWiki Sink implementation.
* <br/>
* <b>Note</b>: The encoding used is UTF-8.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: TWikiSink.java 807179 2009-08-24 12:21:26Z vsiveton $
* @since 1.0
*/
public class TWikiSink
extends AbstractTextSink
implements TWikiMarkup
{
/** The writer to use. */
private final PrintWriter out;
/** The writer to use. */
private StringWriter writer;
/** An indication on if we're in bold mode. */
private boolean boldFlag;
/** An indication on if we're in bold italic or monospaced mode. */
private boolean boldItalicOrMonodpacedFlag;
/** An indication on if we're in head mode. */
private boolean headFlag;
private int levelList = 0;
/** listStyles. */
private final Stack listStyles;
/**
* Constructor, initialize the Writer and the variables.
*
* @param writer not null writer to write the result. <b>Should</b> be an UTF-8 Writer.
* You could use <code>newWriter</code> methods from {@link org.codehaus.plexus.util.WriterFactory}.
*/
protected TWikiSink( Writer writer )
{
this.out = new PrintWriter( writer );
this.listStyles = new Stack();
init();
}
/** {@inheritDoc} */
public void anchor( String name )
{
write( EOL );
write( ANCHOR_MARKUP + name );
}
/** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
anchor( name );
}
/**
* Not used.
* {@inheritDoc}
*/
public void anchor_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void author()
{
// nop
}
/** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
author();
}
/**
* Not used.
* {@inheritDoc}
*/
public void author_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void body()
{
// nop
}
/** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
body();
}
/**
* Not used.
* {@inheritDoc}
*/
public void body_()
{
// nop
}
/** {@inheritDoc} */
public void bold()
{
boldFlag = true;
write( BOLD_START_MARKUP );
}
/** {@inheritDoc} */
public void bold_()
{
boldFlag = false;
if ( !boldItalicOrMonodpacedFlag )
{
write( BOLD_END_MARKUP );
}
boldItalicOrMonodpacedFlag = false;
}
/**
* Not used.
* {@inheritDoc}
*/
public void comment( String comment )
{
// nop
}
/** {@inheritDoc} */
public void close()
{
out.write( writer.toString() );
out.close();
init();
}
/**
* Not used.
* {@inheritDoc}
*/
public void date()
{
// nop
}
/** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
date();
}
/**
* Not used.
* {@inheritDoc}
*/
public void date_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definedTerm()
{
// nop
}
/** {@inheritDoc} */
public void definedTerm( SinkEventAttributes attributes )
{
definedTerm();
}
/**
* Not used.
* {@inheritDoc}
*/
public void definedTerm_()
{
// nop
}
/** {@inheritDoc} */
public void definition()
{
write( DEFINITION_LIST_DEFINITION_MARKUP );
}
/** {@inheritDoc} */
public void definition( SinkEventAttributes attributes )
{
definition();
}
/** {@inheritDoc} */
public void definition_()
{
writeEOL();
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionList()
{
// nop
}
/** {@inheritDoc} */
public void definitionList( SinkEventAttributes attributes )
{
definitionList();
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionList_()
{
// nop
}
/** {@inheritDoc} */
public void definitionListItem()
{
write( DEFINITION_LIST_ITEM_MARKUP );
}
/** {@inheritDoc} */
public void definitionListItem( SinkEventAttributes attributes )
{
definitionListItem();
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionListItem_()
{
// nop
}
/** {@inheritDoc} */
public void figure()
{
write( String.valueOf( LESS_THAN ) + Tag.IMG.toString() + SPACE );
}
/** {@inheritDoc} */
public void figure( SinkEventAttributes attributes )
{
figure();
}
/**
* Not used.
* {@inheritDoc}
*/
public void figure_()
{
write( SLASH + String.valueOf( GREATER_THAN ) );
}
/**
* Not used.
* {@inheritDoc}
*/
public void figureCaption()
{
write( Attribute.ALT.toString() + EQUAL + QUOTE );
}
/** {@inheritDoc} */
public void figureCaption( SinkEventAttributes attributes )
{
figureCaption();
}
/**
* Not used.
* {@inheritDoc}
*/
public void figureCaption_()
{
write( QUOTE + String.valueOf( SPACE ) );
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
write( Attribute.SRC.toString() + EQUAL + QUOTE + name + QUOTE + String.valueOf( SPACE ) );
}
/** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
figureGraphics( src );
}
/** {@inheritDoc} */
public void flush()
{
close();
writer.flush();
}
/** {@inheritDoc} */
public void head()
{
init();
headFlag = true;
}
/** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
head();
}
/** {@inheritDoc} */
public void head_()
{
headFlag = false;
}
/** {@inheritDoc} */
public void horizontalRule()
{
writeEOL( true );
write( HORIZONTAL_RULE_MARKUP );
writeEOL( true );
}
/** {@inheritDoc} */
public void horizontalRule( SinkEventAttributes attributes )
{
horizontalRule();
}
/** {@inheritDoc} */
public void italic()
{
if ( boldFlag )
{
boldItalicOrMonodpacedFlag = true;
String tmp = writer.toString();
writer = new StringWriter();
writer.write( tmp.substring( 0, tmp.length() - 1 ) );
write( BOLD_ITALIC_START_MARKUP );
}
else
{
write( ITALIC_START_MARKUP );
}
}
/** {@inheritDoc} */
public void italic_()
{
if ( boldFlag )
{
write( BOLD_ITALIC_END_MARKUP );
}
else
{
write( ITALIC_END_MARKUP );
}
}
/**
* Not used.
* {@inheritDoc}
*/
public void lineBreak()
{
// nop
}
/** {@inheritDoc} */
public void lineBreak( SinkEventAttributes attributes )
{
lineBreak();
}
/** {@inheritDoc} */
public void link( String name )
{
write( LINK_START_MARKUP + name + LINK_MIDDLE_MARKUP );
}
/** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
link( name );
}
/** {@inheritDoc} */
public void link_()
{
write( LINK_END_MARKUP );
}
/** {@inheritDoc} */
public void list()
{
if ( !writer.toString().endsWith( EOL + EOL ) )
{
writeEOL( true );
}
levelList++;
}
/** {@inheritDoc} */
public void list( SinkEventAttributes attributes )
{
list();
}
/** {@inheritDoc} */
public void list_()
{
levelList--;
}
/** {@inheritDoc} */
public void listItem()
{
String indent = StringUtils.repeat( THREE_SPACES_MARKUP, levelList );
write( indent + LIST_ITEM_MARKUP );
}
/** {@inheritDoc} */
public void listItem( SinkEventAttributes attributes )
{
listItem();
}
/** {@inheritDoc} */
public void listItem_()
{
writeEOL( true );
}
/** {@inheritDoc} */
public void monospaced()
{
if ( boldFlag )
{
boldItalicOrMonodpacedFlag = true;
String tmp = writer.toString();
writer = new StringWriter();
writer.write( tmp.substring( 0, tmp.length() - 1 ) );
write( BOLD_MONOSPACED_START_MARKUP );
}
else
{
write( MONOSPACED_START_MARKUP );
}
}
/** {@inheritDoc} */
public void monospaced_()
{
if ( boldFlag )
{
write( BOLD_MONOSPACED_END_MARKUP );
}
else
{
write( MONOSPACED_END_MARKUP );
}
}
/**
* Not used.
* {@inheritDoc}
*/
public void nonBreakingSpace()
{
// nop
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
levelList++;
String style;
switch ( numbering )
{
case NUMBERING_UPPER_ALPHA:
style = NUMBERING_UPPER_ALPHA_MARKUP;
break;
case NUMBERING_LOWER_ALPHA:
style = NUMBERING_LOWER_ALPHA_MARKUP;
break;
case NUMBERING_UPPER_ROMAN:
style = NUMBERING_UPPER_ROMAN_MARKUP;
break;
case NUMBERING_LOWER_ROMAN:
style = NUMBERING_LOWER_ROMAN_MARKUP;
break;
case NUMBERING_DECIMAL:
default:
style = NUMBERING_MARKUP;
}
listStyles.push( style );
}
/** {@inheritDoc} */
public void numberedList( int numbering, SinkEventAttributes attributes )
{
numberedList( numbering );
}
/** {@inheritDoc} */
public void numberedList_()
{
levelList--;
listStyles.pop();
}
/** {@inheritDoc} */
public void numberedListItem()
{
writeEOL( true );
String style = (String) listStyles.peek();
String indent = StringUtils.repeat( THREE_SPACES_MARKUP, levelList );
write( indent + style + SPACE );
}
/** {@inheritDoc} */
public void numberedListItem( SinkEventAttributes attributes )
{
numberedListItem();
}
/** {@inheritDoc} */
public void numberedListItem_()
{
writeEOL( true );
}
/**
* Not used.
* {@inheritDoc}
*/
public void pageBreak()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void paragraph()
{
// nop
}
/** {@inheritDoc} */
public void paragraph( SinkEventAttributes attributes )
{
paragraph();
}
/** {@inheritDoc} */
public void paragraph_()
{
writeEOL( true );
writeEOL();
}
/**
* Not used.
* {@inheritDoc}
*/
public void rawText( String text )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section( int level, SinkEventAttributes attributes )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section1()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section1_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section2()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section2_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section3()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section3_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section4()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section4_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section5()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section5_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section_( int level )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void sectionTitle()
{
// nop
}
/** {@inheritDoc} */
public void sectionTitle( int level, SinkEventAttributes attributes )
{
if ( level > 0 && level < 6 )
{
write( StringUtils.repeat( "-", 3 ) + StringUtils.repeat( "+", level ) );
}
}
/** {@inheritDoc} */
public void sectionTitle1()
{
sectionTitle( 1, null );
}
/** {@inheritDoc} */
public void sectionTitle1_()
{
sectionTitle_( 1 );
}
/** {@inheritDoc} */
public void sectionTitle2()
{
sectionTitle( 2, null );
}
/** {@inheritDoc} */
public void sectionTitle2_()
{
sectionTitle_( 2 );
}
/** {@inheritDoc} */
public void sectionTitle3()
{
sectionTitle( 3, null );
}
/** {@inheritDoc} */
public void sectionTitle3_()
{
sectionTitle_( 3 );
}
/** {@inheritDoc} */
public void sectionTitle4()
{
sectionTitle( 4, null );
}
/** {@inheritDoc} */
public void sectionTitle4_()
{
sectionTitle_( 4 );
}
/** {@inheritDoc} */
public void sectionTitle5()
{
sectionTitle( 5, null );
}
/** {@inheritDoc} */
public void sectionTitle5_()
{
sectionTitle_( 5 );
}
/**
* Not used.
* {@inheritDoc}
*/
public void sectionTitle_()
{
// nop
}
/** {@inheritDoc} */
public void sectionTitle_( int level )
{
writeEOL( true );
writeEOL();
}
/**
* Not used.
* {@inheritDoc}
*/
public void table()
{
// nop
}
/** {@inheritDoc} */
public void table( SinkEventAttributes attributes )
{
table();
}
/**
* Not used.
* {@inheritDoc}
*/
public void table_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableCaption()
{
// nop
}
/** {@inheritDoc} */
public void tableCaption( SinkEventAttributes attributes )
{
tableCaption();
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableCaption_()
{
// nop
}
/** {@inheritDoc} */
public void tableCell()
{
write( " " );
}
/** {@inheritDoc} */
public void tableCell( SinkEventAttributes attributes )
{
tableCell();
}
/** {@inheritDoc} */
public void tableCell( String width )
{
tableCell();
}
/** {@inheritDoc} */
public void tableCell_()
{
write( TABLE_CELL_MARKUP );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
write( TABLE_CELL_HEADER_START_MARKUP );
}
/** {@inheritDoc} */
public void tableHeaderCell( SinkEventAttributes attributes )
{
tableHeaderCell();
}
/** {@inheritDoc} */
public void tableHeaderCell( String width )
{
tableHeaderCell();
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
write( TABLE_CELL_HEADER_END_MARKUP );
}
/** {@inheritDoc} */
public void tableRow()
{
write( TABLE_ROW_MARKUP );
}
/** {@inheritDoc} */
public void tableRow( SinkEventAttributes attributes )
{
tableRow();
}
/** {@inheritDoc} */
public void tableRow_()
{
writeEOL( true );
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableRows( int[] justification, boolean grid )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableRows_()
{
// nop
}
/** {@inheritDoc} */
public void text( String text )
{
if ( headFlag )
{
return;
}
content( text );
}
/** {@inheritDoc} */
public void text( String text, SinkEventAttributes attributes )
{
if ( attributes == null )
{
text( text );
}
else
{
if ( attributes.containsAttribute( SinkEventAttributes.DECORATION, "underline" ) )
{
writeStartTag( Tag.U );
}
if ( attributes.containsAttribute( SinkEventAttributes.DECORATION, "line-through" ) )
{
writeStartTag( Tag.S );
}
if ( attributes.containsAttribute( SinkEventAttributes.VALIGN, "sub" ) )
{
writeStartTag( Tag.SUB );
}
if ( attributes.containsAttribute( SinkEventAttributes.VALIGN, "sup" ) )
{
writeStartTag( Tag.SUP );
}
text( text );
if ( attributes.containsAttribute( SinkEventAttributes.VALIGN, "sup" ) )
{
writeEndTag( Tag.SUP );
}
if ( attributes.containsAttribute( SinkEventAttributes.VALIGN, "sub" ) )
{
writeEndTag( Tag.SUB );
}
if ( attributes.containsAttribute( SinkEventAttributes.DECORATION, "line-through" ) )
{
writeEndTag( Tag.S );
}
if ( attributes.containsAttribute( SinkEventAttributes.DECORATION, "underline" ) )
{
writeEndTag( Tag.U );
}
}
}
/**
* Not used.
* {@inheritDoc}
*/
public void title()
{
// nop
}
/** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
title();
}
/**
* Not used.
* {@inheritDoc}
*/
public void title_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
// nop
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
SinkEventAttributeSet att = new SinkEventAttributeSet();
if ( boxed )
{
att.addAttribute( SinkEventAttributes.DECORATION, "boxed" );
}
verbatim( att );
}
/** {@inheritDoc} */
public void verbatim( SinkEventAttributes attributes )
{
MutableAttributeSet atts = SinkUtils.filterAttributes( attributes, SinkUtils.SINK_VERBATIM_ATTRIBUTES );
if ( atts == null )
{
atts = new SinkEventAttributeSet();
}
boolean boxed = false;
if ( atts.isDefined( SinkEventAttributes.DECORATION ) )
{
boxed = "boxed".equals( atts.getAttribute( SinkEventAttributes.DECORATION ).toString() );
}
if ( boxed )
{
atts.addAttribute( Attribute.CLASS, "source" );
}
atts.removeAttribute( SinkEventAttributes.DECORATION );
String width = (String) atts.getAttribute( Attribute.WIDTH.toString() );
atts.removeAttribute( Attribute.WIDTH.toString() );
writeStartTag( Tag.DIV, atts );
writeEOL( true );
if ( width != null )
{
atts.addAttribute( Attribute.WIDTH.toString(), width );
}
atts.removeAttribute( Attribute.ALIGN.toString() );
atts.removeAttribute( Attribute.CLASS.toString() );
writeStartTag( VERBATIM_TAG, atts );
}
/** {@inheritDoc} */
public void verbatim_()
{
writeEndTag( VERBATIM_TAG );
writeEOL( true );
writeEndTag( Tag.DIV );
writeEOL( true );
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
private void write( String text )
{
writer.write( unifyEOLs( text ) );
}
/**
* Starts a Tag. For instance:
* <pre>
* <tag>
* </pre>
* <br/>
* <b>Note</b>: Copy from {@link AbstractXmlSink#writeStartTag(javax.swing.text.html.HTML.Tag)}
*
* @param t a non null tag
* @see #writeStartTag(javax.swing.text.html.HTML.Tag)
*/
private void writeStartTag( Tag t )
{
writeStartTag( t, null );
}
/**
* Starts a Tag with attributes. For instance:
* <pre>
* <tag attName="attValue">
* </pre>
* <br/>
* <b>Note</b>: Copy from {@link AbstractXmlSink#writeStartTag(javax.swing.text.html.HTML.Tag,
* javax.swing.text.MutableAttributeSet)}
*
* @param t a non null tag
* @param att a set of attributes
* @see #writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet, boolean)
*/
private void writeStartTag( Tag t, MutableAttributeSet att )
{
writeStartTag( t, att, false );
}
/**
* Starts a Tag with attributes. For instance:
* <pre>
* <tag attName="attValue">
* </pre>
* <br/>
* <b>Note</b>: Copy from {@link AbstractXmlSink#writeStartTag(javax.swing.text.html.HTML.Tag,
* javax.swing.text.MutableAttributeSet, boolean)}
*
* @param t a non null tag
* @param att a set of attributes
* @param isSimpleTag boolean to write as a simple tag
*/
private void writeStartTag( Tag t, MutableAttributeSet att, boolean isSimpleTag )
{
if ( t == null )
{
throw new IllegalArgumentException( "A tag is required" );
}
StringBuffer sb = new StringBuffer();
sb.append( LESS_THAN );
sb.append( t.toString() );
sb.append( SinkUtils.getAttributeString( att ) );
if ( isSimpleTag )
{
sb.append( SPACE ).append( SLASH );
}
sb.append( GREATER_THAN );
write( sb.toString() );
}
/**
* Writes a system EOL.
*/
private void writeEOL()
{
write( EOL );
}
/**
* Writes a system EOL, with or without trim.
*/
private void writeEOL( boolean trim )
{
if ( !trim )
{
writeEOL();
return;
}
String tmp = writer.toString().trim();
writer = new StringWriter();
writer.write( tmp );
write( EOL );
}
/**
* Ends a Tag without writing an EOL. For instance: <pre></tag></pre>.
* <br/>
* <b>Note</b>: Copy from {@link AbstractXmlSink#writeEndTag(javax.swing.text.html.HTML.Tag)}
*
* @param t a tag.
*/
private void writeEndTag( Tag t )
{
StringBuffer sb = new StringBuffer();
sb.append( LESS_THAN );
sb.append( SLASH );
sb.append( t.toString() );
sb.append( GREATER_THAN );
write( sb.toString() );
}
/**
* Write HTML escaped text to output.
*
* @param text The text to write.
*/
protected void content( String text )
{
write( escapeHTML( text ) );
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.writer = new StringWriter();
this.headFlag = false;
this.levelList = 0;
this.listStyles.clear();
this.boldFlag = false;
this.boldItalicOrMonodpacedFlag = false;
}
/**
* Forward to HtmlTools.escapeHTML( text ).
*
* @param text the String to escape, may be null
* @return the text escaped, "" if null String input
* @see org.apache.maven.doxia.util.HtmlTools#escapeHTML(String)
*/
protected static String escapeHTML( String text )
{
return HtmlTools.escapeHTML( text );
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWiki0000644 0001750 0001750 00000017402 11244502706 033316 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.twiki.parser.Block;
import org.apache.maven.doxia.module.twiki.parser.BlockParser;
import org.apache.maven.doxia.module.twiki.parser.FormatedTextParser;
import org.apache.maven.doxia.module.twiki.parser.GenericListBlockParser;
import org.apache.maven.doxia.module.twiki.parser.HRuleBlockParser;
import org.apache.maven.doxia.module.twiki.parser.ParagraphBlockParser;
import org.apache.maven.doxia.module.twiki.parser.SectionBlock;
import org.apache.maven.doxia.module.twiki.parser.SectionBlockParser;
import org.apache.maven.doxia.module.twiki.parser.TableBlockParser;
import org.apache.maven.doxia.module.twiki.parser.TextParser;
import org.apache.maven.doxia.module.twiki.parser.VerbatimBlockParser;
import org.apache.maven.doxia.module.twiki.parser.XHTMLWikiWordLinkResolver;
import org.apache.maven.doxia.parser.AbstractTextParser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
import java.io.Reader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
/**
* Parse the <a href="http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules">
* twiki file format</a>
*
* @author Juan F. Codagnone
* @version $Id: TWikiParser.java 807179 2009-08-24 12:21:26Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="twiki"
*/
public class TWikiParser
extends AbstractTextParser
{
private static final int EXTENSION_LENGTH = 6;
/** paragraph parser. */
private final ParagraphBlockParser paraParser = new ParagraphBlockParser();
/** section parser. */
private final SectionBlockParser sectionParser = new SectionBlockParser();
/** enumeration parser. */
private final GenericListBlockParser listParser = new GenericListBlockParser();
/** Text parser. */
private final FormatedTextParser formatTextParser = new FormatedTextParser();
/**
* text parser.
* This only works for xhtml output, but there is no way
* of transforming a wikiWord in another context.
*/
private final TextParser textParser = new TextParser( new XHTMLWikiWordLinkResolver() );
/** hruler parser. */
private final HRuleBlockParser hrulerParser = new HRuleBlockParser();
/** table parser. */
private final TableBlockParser tableParser = new TableBlockParser();
/** verbatim parser. */
private final VerbatimBlockParser verbatimParser = new VerbatimBlockParser();
/** list of parsers to try to apply to the toplevel */
private BlockParser[] parsers;
/**
* Creates the TWikiParser.
*/
public TWikiParser()
{
init();
}
/**
* <p>parse.</p>
*
* @param source source to parse.
* @return the blocks that represent source.
* @throws org.apache.maven.doxia.parser.ParseException on error.
*/
public final List parse( final ByLineSource source )
throws ParseException
{
final List ret = new ArrayList();
String line;
while ( ( line = source.getNextLine() ) != null )
{
boolean accepted = false;
for ( int i = 0; i < parsers.length; i++ )
{
final BlockParser parser = parsers[i];
if ( parser.accept( line ) )
{
accepted = true;
ret.add( parser.visit( line, source ) );
break;
}
}
if ( !accepted )
{
throw new ParseException( "Line number not handle : " + source.getLineNumber() + ": " + line );
}
}
return ret;
}
/** {@inheritDoc} */
public final synchronized void parse( final Reader source, final Sink sink )
throws ParseException
{
init();
List blocks;
final ByLineSource src = new ByLineReaderSource( source );
try
{
blocks = parse( src );
}
catch ( final Exception e )
{
// TODO handle column number
throw new ParseException( e, src.getName(), src.getLineNumber(), -1 );
}
sink.head();
final String title = getTitle( blocks, src );
if ( title != null )
{
sink.title();
sink.text( title );
sink.title_();
}
sink.head_();
sink.body();
for ( Iterator it = blocks.iterator(); it.hasNext(); )
{
final Block block = (Block) it.next();
block.traverse( sink );
}
sink.body_();
sink.flush();
sink.close();
setSecondParsing( false );
init();
}
/**
* Guess a title for the page. It uses the first section that it finds.
* If it doesn't find any section tries to get it from
* {@link ByLineReaderSource#getName()}
*
* @param blocks blocks to parse
* @param source source to parse
* @return a title for a page
* @since 1.1
*/
public final String getTitle( final List blocks, final ByLineSource source )
{
String title = null;
for ( Iterator it = blocks.iterator(); title == null && it.hasNext(); )
{
final Block block = (Block) it.next();
if ( block instanceof SectionBlock )
{
final SectionBlock sectionBlock = (SectionBlock) block;
title = sectionBlock.getTitle();
}
}
if ( title == null )
{
String name = source.getName();
if ( name != null )
{
name = name.trim();
if ( name.length() != 0 )
{
if ( name.endsWith( ".twiki" ) )
{
title = name.substring( 0, name.length() - EXTENSION_LENGTH );
}
else
{
title = name;
}
}
}
}
return title;
}
/** {@inheritDoc} */
protected void init()
{
super.init();
paraParser.setSectionParser( sectionParser );
paraParser.setListParser( listParser );
paraParser.setTextParser( formatTextParser );
paraParser.setHrulerParser( hrulerParser );
paraParser.setTableBlockParser( tableParser );
paraParser.setVerbatimParser( verbatimParser );
sectionParser.setParaParser( paraParser );
sectionParser.setHrulerParser( hrulerParser );
sectionParser.setVerbatimBlockParser( verbatimParser );
listParser.setTextParser( formatTextParser );
formatTextParser.setTextParser( textParser );
tableParser.setTextParser( formatTextParser );
this.parsers = new BlockParser[] { sectionParser, hrulerParser, verbatimParser, paraParser };
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWikiMarkup.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/TWiki0000644 0001750 0001750 00000011106 11150514042 033301 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.markup.TextMarkup;
/**
* This interface defines all markups and syntaxes used by the <b>TWiki</b> format.
*
* @see <a href="http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules">http://twiki.org/cgi-bin/view/TWiki/TextFormattingRules</a>
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: TWikiMarkup.java 746991 2009-02-23 12:35:46Z vsiveton $
* @since 1.0
*/
public interface TWikiMarkup
extends TextMarkup
{
// ----------------------------------------------------------------------
// Twiki markups
// ----------------------------------------------------------------------
/** Syntax for the anchor : '#' */
char ANCHOR_MARKUP = '#';
/** Syntax for the start line separator: " " */
String THREE_SPACES_MARKUP = " ";
/** Syntax for the bold markup: "*" */
String BOLD_END_MARKUP = "*";
/** Syntax for the bold markup: "*" */
String BOLD_START_MARKUP = "*";
/** Syntax for the bold italic markup: "__" */
String BOLD_ITALIC_END_MARKUP = "__";
/** Syntax for the bold italic markup: "__" */
String BOLD_ITALIC_START_MARKUP = "__";
/** Syntax for the bold monospaced markup: "==" */
String BOLD_MONOSPACED_END_MARKUP = "==";
/** Syntax for the bold monospaced markup: "==" */
String BOLD_MONOSPACED_START_MARKUP = "==";
/** Syntax for the definition list item: " $ " */
String DEFINITION_LIST_ITEM_MARKUP = THREE_SPACES_MARKUP + "$ ";
/** Syntax for the definition list definition: ": " */
String DEFINITION_LIST_DEFINITION_MARKUP = ": ";
/** Syntax for the horizontal rule markup: "---" */
String HORIZONTAL_RULE_MARKUP = "---";
/** Syntax for the italic markup: "_" */
String ITALIC_END_MARKUP = "_";
/** Syntax for the italic markup: "_" */
String ITALIC_START_MARKUP = "_";
/** Syntax for the link end markup: "]]" */
String LINK_END_MARKUP = "]]";
/** Syntax for the link middle markup: "][" */
String LINK_MIDDLE_MARKUP = "][";
/** Syntax for the link start markup: "[[" */
String LINK_START_MARKUP = "[[";
/** Syntax for the list item markup: "* */
String LIST_ITEM_MARKUP = "* ";
/** Syntax for the mono-spaced style end: "=" */
String MONOSPACED_END_MARKUP = "=";
/** Syntax for the mono-spaced style start: "=" */
String MONOSPACED_START_MARKUP = "=";
/** Syntax for the numbering decimal markup char: "1." */
String NUMBERING_MARKUP = "1.";
/** Syntax for the numbering lower alpha markup char: "a." */
String NUMBERING_LOWER_ALPHA_MARKUP = "a.";
/** Syntax for the numbering lower roman markup char: "i." */
String NUMBERING_LOWER_ROMAN_MARKUP = "i.";
/** Syntax for the numbering upper alpha markup char: "A." */
String NUMBERING_UPPER_ALPHA_MARKUP = "A.";
/** Syntax for the numbering upper roman markup char: "I." */
String NUMBERING_UPPER_ROMAN_MARKUP = "I.";
/** Syntax for the table cell header end markup: "* |" */
String TABLE_CELL_HEADER_END_MARKUP = "* |";
/** Syntax for the table cell header start markup: " *" */
String TABLE_CELL_HEADER_START_MARKUP = " *";
/** Syntax for the table cell markup: "| " */
String TABLE_CELL_MARKUP = " |";
/** Syntax for the table row markup: "|" */
String TABLE_ROW_MARKUP = "|";
// ----------------------------------------------------------------------
// Specific Twiki tags
// ----------------------------------------------------------------------
/** TWiki tag for <code>verbatim</code> */
Tag VERBATIM_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "verbatim";
}
};
}
././@LongLink 0000000 0000000 0000000 00000000147 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000755 0001750 0001750 00000000000 11632765560 033405 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000176 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NumeratedListBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000004221 11167436114 033377 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* <pre>
* 1. item1
* 2. item2
* - item2.1
* ...
* </pre>
*
* @author Juan F. Codagnone
* @version $Id: NumeratedListBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class NumeratedListBlock
extends ListBlock
{
/**
* order item type. one of Sink#NUMBERING_....
*/
private final int type;
/**
* Creates the UnorderedListBlock.
*
* @param type order item type. one of Sink#NUMBERING_....
* @param blocks list of list items, not null.
*/
NumeratedListBlock( final int type, final ListItemBlock[] blocks )
{
super( blocks );
this.type = type;
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.numberedList( type );
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.numberedList_();
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( super.equals( obj ) )
{
ret = type == ( (NumeratedListBlock) obj ).type;
}
return ret;
}
/** {@inheritDoc} */
public final int hashCode()
{
final int magic = 17;
return super.hashCode() + magic * type;
}
}
././@LongLink 0000000 0000000 0000000 00000000205 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLWikiWordLinkResolver.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002730 11150514042 033367 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Transform WikiWord to HTML links
*
* @author Christian Nardi
* @version $Id: XHTMLWikiWordLinkResolver.java 746991 2009-02-23 12:35:46Z vsiveton $
* @since 1.1
*/
public class XHTMLWikiWordLinkResolver
implements WikiWordLinkResolver
{
/**
* {@inheritDoc}
*
* This only works for xhtml output, but there is no way
* of transforming a wikiWord in another context.
* @see org.apache.maven.doxia.module.twiki.parser.WikiWordLinkResolver#resolveLink(java.lang.String)
*/
public final String resolveLink( final String wikiWord )
{
return "./" + wikiWord + ".html";
}
}
././@LongLink 0000000 0000000 0000000 00000000172 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/MonospaceBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002770 11075462240 033403 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents the monospaced text format
*
* @author Juan F. Codagnone
* @version $Id: MonospaceBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class MonospaceBlock
extends AbstractFatherBlock
{
/**
* Creates the MonospaceBlock.
*
* @param childBlocks child blocks
*/
MonospaceBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.monospaced();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.monospaced_();
}
}
././@LongLink 0000000 0000000 0000000 00000000176 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/FormatedTextParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000022146 11102715517 033401 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
/**
* Parse looking for formated text (bold, italic, ...)
*
* @author Juan F. Codagnone
* @version $Id: FormatedTextParser.java 709605 2008-10-31 23:57:03Z hboutemy $
*/
public class FormatedTextParser
{
/**
* parser used to parse text...
*/
private TextParser textParser;
/**
* map used to create blocks dependening on the text format
*/
private static final Map FACTORY_MAP = new HashMap();
/**
* creates bold blocks
*/
private static final FormatBlockFactory BOLD_FACTORY = new FormatBlockFactory()
{
/** {@inheritDoc} */
public Block createBlock( final Block[] childrens )
{
return new BoldBlock( childrens );
}
};
/**
* creates italic blocks
*/
private static final FormatBlockFactory ITALIC_FACTORY = new FormatBlockFactory()
{
/** {@inheritDoc} */
public Block createBlock( final Block[] childrens )
{
return new ItalicBlock( childrens );
}
};
/**
* creates monospaced blocks
*/
private static final FormatBlockFactory MONOSPACED_FACTORY = new FormatBlockFactory()
{
/** {@inheritDoc} */
public Block createBlock( final Block[] childrens )
{
return new MonospaceBlock( childrens );
}
};
/**
* creates bold italic blocks
*/
private static final FormatBlockFactory BOLDITALIC_FACTORY = new FormatBlockFactory()
{
/** {@inheritDoc} */
public Block createBlock( final Block[] childrens )
{
return new BoldBlock( new Block[] { new ItalicBlock( childrens ) } );
}
};
/**
* creates bold monospace blocks
*/
private static final FormatBlockFactory BOLDMONO_FACTORY = new FormatBlockFactory()
{
/** {@inheritDoc} */
public Block createBlock( final Block[] childrens )
{
return new BoldBlock( new Block[] { new MonospaceBlock( childrens ) } );
}
};
/**
* format characters
*/
private static final String[] SPECIAL_CHAR = new String[] { "__", "==", "*", "_", "=" };
static
{
FACTORY_MAP.put( "*", BOLD_FACTORY );
FACTORY_MAP.put( "_", ITALIC_FACTORY );
FACTORY_MAP.put( "=", MONOSPACED_FACTORY );
FACTORY_MAP.put( "__", BOLDITALIC_FACTORY );
FACTORY_MAP.put( "==", BOLDMONO_FACTORY );
}
/**
* @param line line to parse
* @return TextBlock, ItalicBlock, BoldBlock, MonospacedBlock, ...
*/
final Block[] parse( final String line )
{
return (Block[]) parseFormat( line ).toArray( new Block[] {} );
}
/**
* @param c character to test
* @return <code>true</code> if c is a space character
*/
static boolean isSpace( final char c )
{
return c == ' ' || c == '\t';
}
/**
* @param c character to test
* @return <code>true</code> if c is a character that limits the formats
*/
static boolean isSpecial( final char c )
{
boolean ret = false;
for ( int i = 0; !ret && i < SPECIAL_CHAR.length; i++ )
{
if ( SPECIAL_CHAR[i].charAt( 0 ) == c )
{
ret = true;
}
}
return ret;
}
/**
* Parse text format (bold, italic...)
* <p/>
* TODO too many lines!!
*
* @param line line to parse
* @return list of blocks
*/
private List parseFormat( final String line )
{
final List ret = new ArrayList();
final int[] lhOffsets = new int[SPECIAL_CHAR.length];
final int[] rhOffsets = new int[SPECIAL_CHAR.length];
// for each text format markers...
for ( int i = 0; i < SPECIAL_CHAR.length; i++ )
{
final int specialLen = SPECIAL_CHAR[i].length();
int t = 0;
// search the nearset instance of this marker...
while ( t != -1 && ( t = line.indexOf( SPECIAL_CHAR[i], t ) ) != -1 )
{
// and check if it at the begining of a word.
if ( t == 0 || isSpace( line.charAt( t - 1 ) ) || isParenthesis( line.charAt( t - 1 ) ) )
{
// if it is, and if, check to avoid going beyond the string
if ( t + specialLen < line.length() )
{
// and if character after the format marker is another
// marker, is an error, and should be ignored
if ( isSpecial( line.charAt( t + specialLen ) ) )
{
t += specialLen;
}
else
{
// else we find a starter!
break;
}
}
else
{
t = -1;
}
}
else
{
t += specialLen;
}
}
lhOffsets[i] = t;
}
// for each text format markers...
for ( int i = 0; i < lhOffsets.length; i++ )
{
final int specialLen = SPECIAL_CHAR[i].length();
// if we found a text format beginning
if ( lhOffsets[i] != -1 )
{
int t = lhOffsets[i] + specialLen;
// search for a text format ending
while ( ( t = line.indexOf( SPECIAL_CHAR[i], t ) ) != -1 )
{
// must be side by side to a word
final char c = line.charAt( t - 1 );
if ( t > 0 && !isSpace( c ) && !isSpecial( c ) )
{
break;
}
else
{
t += specialLen;
}
}
rhOffsets[i] = t;
}
}
// find the nearest index
int minIndex = -1;
int charType = 0;
for ( int i = 0; i < lhOffsets.length; i++ )
{
if ( lhOffsets[i] != -1 && rhOffsets[i] != 1 )
{
if ( minIndex == -1 || lhOffsets[i] < minIndex )
{
if ( rhOffsets[i] > lhOffsets[i] )
{
// ej: "mary *has a little lamb"
minIndex = lhOffsets[i];
charType = i;
}
}
}
}
if ( minIndex == -1 )
{
ret.addAll( textParser.parse( line ) );
}
else
{
int len = SPECIAL_CHAR[charType].length();
ret.addAll( parseFormat( line.substring( 0, minIndex ) ) );
ret.add( ( (FormatBlockFactory) FACTORY_MAP.get( SPECIAL_CHAR[charType] ) )
.createBlock( (Block[]) parseFormat( line.substring( minIndex + len, rhOffsets[charType] ) )
.toArray( new Block[] {} ) ) );
ret.addAll( parseFormat( line.substring( rhOffsets[charType] + len ) ) );
}
// profit
return ret;
}
/**
* @param c character to test
* @return <code>true</code> if c is a parenthesis
*/
private boolean isParenthesis( final char c )
{
return c == '(' || c == ')';
}
/**
* Sets the formatTextParser.
*
* @param textParser text parser to use
* <code>TextParser</code> with the formatTextParser.
*/
public final void setTextParser( final TextParser textParser )
{
if ( textParser == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.textParser = textParser;
}
}
/**
* @author Juan F. Codagnone
* @version $Id: FormatedTextParser.java 709605 2008-10-31 23:57:03Z hboutemy $
*/
interface FormatBlockFactory
{
/**
* factory method of format <code>Block</code>
*
* @param childrens children of the format block
* @return a format block
*/
Block createBlock( final Block[] childrens );
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HorizontalRuleBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000003003 11075462240 033371 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Represents an horizontal block
*
* @author Juan F. Codagnone
* @version $Id: HorizontalRuleBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class HorizontalRuleBlock
implements Block
{
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.horizontalRule();
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
return obj == this || ( obj != null && getClass().equals( obj.getClass() ) );
}
/** {@inheritDoc} */
public final int hashCode()
{
final int hashCode = 214905655;
return hashCode;
}
}
././@LongLink 0000000 0000000 0000000 00000000176 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/UnorderedListBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000003135 11167436114 033402 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* <pre>
* - item1
* - item2
* - item2.1
* ...
* </pre>
*
* @author Juan F. Codagnone
* @version $Id: UnorderedListBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class UnorderedListBlock
extends ListBlock
{
/**
* Creates the UnorderedListBlock.
*
* @param blocks list of list items
* @throws IllegalArgumentException if listItemBlocks is <code>null</code>
*/
UnorderedListBlock( final ListItemBlock[] blocks )
{
super( blocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.list();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.list_();
}
}
././@LongLink 0000000 0000000 0000000 00000000171 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000007173 11102715517 033404 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Represent a WikiWord
*
* @author Juan F. Codagnone
* @version $Id: WikiWordBlock.java 709605 2008-10-31 23:57:03Z hboutemy $
*/
class WikiWordBlock
implements Block
{
/**
* the wiki word
*/
private final String wikiword;
/**
* content to show in the wiki word link
*/
private final Block content;
/**
* Resolves WikiWord links
*/
private final WikiWordLinkResolver wikiWordLinkResolver;
/**
* @see #WikiWordBlock(String, String)
* @param aWikiword the wikiWord
* @param resolver responsible of resolving the link to the wikiWord
*/
WikiWordBlock( final String aWikiword, final WikiWordLinkResolver resolver )
{
this( aWikiword, aWikiword, resolver );
}
/**
* Creates the WikiWordBlock.
*
* @param aWikiword the wiki word
* @param aText text to show in the wiki link
* @param resolver responsible of resolving the link to the wikiWord
* @throws IllegalArgumentException if the wikiword is <code>null</code>
* @deprecated
*/
WikiWordBlock( final String aWikiword, final String aText, final WikiWordLinkResolver resolver )
{
this( aWikiword, new TextBlock( aText ), resolver );
}
/**
* Creates the WikiWordBlock.
*
* @param aWikiword the wiki word
* @param content content to show in the wiki link
* @param resolver responsible of resolving the link to the wikiWord
* @throws IllegalArgumentException if the wikiword is <code>null</code>
*/
WikiWordBlock( final String aWikiword, final Block content, final WikiWordLinkResolver resolver )
{
if ( aWikiword == null || content == null || resolver == null )
{
throw new IllegalArgumentException( "arguments can't be null" );
}
this.wikiword = aWikiword;
this.content = content;
this.wikiWordLinkResolver = resolver;
}
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.link( wikiWordLinkResolver.resolveLink( wikiword ) );
content.traverse( sink );
sink.link_();
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj instanceof WikiWordBlock )
{
final WikiWordBlock w = (WikiWordBlock) obj;
ret = wikiword.equals( w.wikiword ) && content.equals( w.content );
}
return ret;
}
/** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
final int magic2 = 37;
return magic1 + magic2 * wikiword.hashCode() + magic2 * content.hashCode();
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000005102 11150514042 033363 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineSource;
/**
* Parse verbatim blocks
*
* @author Christian Nardi
* @version $Id: VerbatimBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
* @since 1.1
*/
public class VerbatimBlockParser
implements BlockParser
{
/**
* pattern to detect verbatim start tags
*/
private static final Pattern VERBATIM_START_PATTERN = Pattern.compile( "\\s*<verbatim>" );
private static final Pattern VERBATIM_END_PATTERN = Pattern.compile( "</verbatim>" );
/** {@inheritDoc} */
public final boolean accept( final String line )
{
return VERBATIM_START_PATTERN.matcher( line ).lookingAt();
}
/**
* {@inheritDoc}
*/
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
if ( !accept( line ) )
{
throw new IllegalAccessError( "call accept before this ;)" );
}
final List lines = new ArrayList();
Matcher matcher = VERBATIM_START_PATTERN.matcher( line );
matcher.find();
String l = line.substring( matcher.end() );
while ( l != null )
{
matcher = VERBATIM_END_PATTERN.matcher( l );
if ( matcher.find() )
{
lines.add( new TextBlock( l.substring( 0, matcher.start() ) + "\n" ) );
break;
}
lines.add( new TextBlock( l + "\n" ) );
l = source.getNextLine();
}
return new VerbatimBlock( (Block[]) lines.toArray( new Block[] {} ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000164 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/NopBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002723 11075462240 033401 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that not represent anything
*
* @author Juan F. Codagnone
* @version $Id: NopBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class NopBlock
implements Block
{
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
// nothing to do!!
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
return this == obj && getClass().equals( obj.getClass() );
}
/** {@inheritDoc} */
public final int hashCode()
{
final int magic = 518409602;
return magic;
}
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000004624 11167436114 033406 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that holds plain text
*
* @author Juan F. Codagnone
* @version $Id: TextBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class TextBlock
implements Block
{
/**
* the text
*/
private final String text;
/**
* Creates the TextBlock.
*
* @param text some text. can't ben <code>null</code>
* @throws IllegalArgumentException if parameters are not in the domain
*/
TextBlock( final String text )
{
if ( text == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.text = text;
}
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.text( text );
}
/** {@inheritDoc} */
public final String toString()
{
return getClass().getName() + ": [" + text.replaceAll( "\n", "\\n" ) + "]";
}
/**
* Returns the text.
*
* @return <code>String</code> with the text.
*/
final String getText()
{
return text;
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj instanceof TextBlock )
{
final TextBlock textBlock = (TextBlock) obj;
ret = text.equals( textBlock.text );
}
return ret;
}
/** {@inheritDoc} */
public final int hashCode()
{
return text.hashCode();
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AbstractFatherBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000006703 11075462240 033403 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Arrays;
import org.apache.maven.doxia.sink.Sink;
/**
* Generic Block for the Block that have child blocks.
*
* @author Juan F. Codagnone
* @version $Id: AbstractFatherBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
abstract class AbstractFatherBlock
implements Block
{
/**
* @see AbstractFatherBlock#AbstractFatherBlock(Block[])
*/
private final Block[] childBlocks;
/**
* method called before traversing the childs
*
* @param sink a sink to fill
*/
abstract void before( Sink sink );
/**
* method called after traversing the childs
*
* @param sink a sink to fill
*/
abstract void after( Sink sink );
/**
* Creates the AbstractFatherBlock.
*
* @param childBlocks child blocks
*/
AbstractFatherBlock( final Block[] childBlocks )
{
if ( childBlocks == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
for ( int i = 0; i < childBlocks.length; i++ )
{
if ( childBlocks[i] == null )
{
throw new IllegalArgumentException( "bucket " + i + " can't be null" );
}
}
this.childBlocks = childBlocks;
}
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
before( sink );
for ( int i = 0; i < childBlocks.length; i++ )
{
Block block = childBlocks[i];
block.traverse( sink );
}
after( sink );
}
/**
* Returns the childBlocks.
*
* @return <code>Block[]</code> with the childBlocks.
*/
public final Block[] getBlocks()
{
return childBlocks;
}
/** {@inheritDoc}*/
public boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj == null )
{
ret = false;
}
else if ( obj.getClass().equals( this.getClass() ) )
{
if ( obj instanceof AbstractFatherBlock )
{
final AbstractFatherBlock a = (AbstractFatherBlock) obj;
ret = Arrays.equals( a.childBlocks, this.childBlocks );
}
}
return ret;
}
/** {@inheritDoc}*/
public int hashCode()
{
int result = 1;
if ( childBlocks != null )
{
for ( int i = 0; i < childBlocks.length; i++ )
{
result += childBlocks[i].hashCode();
}
}
return result;
}
}
././@LongLink 0000000 0000000 0000000 00000000170 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000010657 11167436114 033411 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.lang.reflect.Method;
import java.util.Collections;
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents a section
*
* @author Juan F. Codagnone
* @version $Id: SectionBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class SectionBlock
extends AbstractFatherBlock
{
/** {@inheritDoc} */
private final String title;
/** {@inheritDoc} */
private final int level;
/**
* Creates the SectionBlock.
* <p/>
* No parameter can be <code>null</code>
*
* @param title the section title.
* @param level the section level: 0 < level < 6
* @param blocks child blocks
*/
public SectionBlock( final String title, final int level, final Block[] blocks )
{
super( blocks );
final int maxLevel = 5;
if ( title == null )
{
throw new IllegalArgumentException( "title cant be null" );
}
else if ( level < 1 || level > maxLevel )
{
throw new IllegalArgumentException( "invalid level: " + level );
}
this.title = title;
this.level = level;
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sectionStart( sink );
sectionTitle( sink );
sink.text( title );
sectionTitle_( sink );
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sectionEnd( sink );
}
/**
* call to sink.section<Level>()
*
* @param sink sink
*/
private void sectionStart( final Sink sink )
{
invokeVoidVoid( sink, "section" + level );
}
/**
* call to sink.section<Level>_()
*
* @param sink sink
*/
private void sectionEnd( final Sink sink )
{
invokeVoidVoid( sink, "section" + level + "_" );
}
/**
* Let you call sink's methods that returns <code>null</code> and have
* no parameters.
*
* @param sink the Sink
* @param name the name of the method to call
*/
private void invokeVoidVoid( final Sink sink, final String name )
{
try
{
final Method m = sink.getClass().getMethod( name, new Class[] {} );
m.invoke( sink, Collections.EMPTY_LIST.toArray() );
}
catch ( Exception e )
{
// FIXME
throw new IllegalArgumentException( "invoking sink's " + name + " method: " + e.getMessage() );
}
}
/**
* Returns the level.
*
* @return <code>int</code> with the level.
*/
public final int getLevel()
{
return level;
}
/**
* Returns the title.
*
* @return <code>String</code> with the title.
*/
public final String getTitle()
{
return title;
}
/** {@inheritDoc} */
public final String toString()
{
final StringBuffer sb = new StringBuffer();
sb.append( "Section {title: '" );
sb.append( getTitle() );
sb.append( "' level: " );
sb.append( getLevel() );
sb.append( "}: [" );
for ( int i = 0; i < getBlocks().length; i++ )
{
final Block block = getBlocks()[i];
sb.append( block.toString() );
sb.append( ", " );
}
sb.append( "]" );
return sb.toString();
}
/** @param sink */
private void sectionTitle( final Sink sink )
{
invokeVoidVoid( sink, "sectionTitle" + level );
}
/** @param sink */
private void sectionTitle_( final Sink sink )
{
invokeVoidVoid( sink, "sectionTitle" + level + "_" );
}
}
././@LongLink 0000000 0000000 0000000 00000000171 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/VerbatimBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000003060 11151264317 033374 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* Represents a verbatim block
*
* @author Christian Nardi
* @version $Id: VerbatimBlock.java 747837 2009-02-25 15:50:39Z ltheussl $
*/
class VerbatimBlock
extends AbstractFatherBlock
{
/**
* Creates the VerbatimBlock.
*
* @param childBlocks child blocks
*/
VerbatimBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.verbatim( SinkEventAttributeSet.BOXED );
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.verbatim_();
}
}
././@LongLink 0000000 0000000 0000000 00000000200 00000000000 011555 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellHeaderBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002771 11075462240 033404 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Table Cell headear
*
* @author Juan F. Codagnone
* @version $Id: TableCellHeaderBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class TableCellHeaderBlock
extends AbstractFatherBlock
{
/**
* Creates the TableCellHeaderBlock.
*
* @param childBlocks childrens
*/
TableCellHeaderBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.tableHeaderCell();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.tableHeaderCell_();
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ImageBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000004406 11075462240 033401 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents an image.
*
* @author Christian Nardi
* @version $Id: ImageBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class ImageBlock
implements Block
{
/**
* img reference
*/
private final String reference;
/**
* Creates the ImageBlock.
*
* @param imgReference img reference
* @throws IllegalArgumentException if the argument is <code>null</code>
*/
ImageBlock( final String imgReference )
{
if ( imgReference == null )
{
throw new IllegalArgumentException( "arguments can't be null" );
}
this.reference = imgReference;
}
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.figure();
sink.figureGraphics( reference );
sink.figure_();
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj instanceof ImageBlock )
{
final ImageBlock l = (ImageBlock) obj;
ret = reference.equals( l.reference );
}
return ret;
}
/** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
final int magic2 = 37;
return magic1 + magic2 * reference.hashCode();
}
}
././@LongLink 0000000 0000000 0000000 00000000200 00000000000 011555 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/WikiWordLinkResolver.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002370 10767707462 033416 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Resolves the WikiWordLinks
*
* @author Christian D. Nardi
* @version $Id: WikiWordLinkResolver.java 638290 2008-03-18 09:45:22Z bentmann $
*/
interface WikiWordLinkResolver
{
/**
* Given a wikiWord, it returns a link string.
*
* @param wikiWord wikiWord to resolve
* @return the link representation of the wikiWord.
*/
String resolveLink( final String wikiWord );
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BoldBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002731 11075462240 033400 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents the bold text format
*
* @author Juan F. Codagnone
* @version $Id: BoldBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class BoldBlock
extends AbstractFatherBlock
{
/**
* Creates the BoldBlock.
*
* @param childBlocks child blocks
*/
public BoldBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.bold();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.bold_();
}
}
././@LongLink 0000000 0000000 0000000 00000000174 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000006712 11150514042 033373 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Parse tables
*
* @author Juan F. Codagnone
* @version $Id: TableBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
*/
public class TableBlockParser
implements BlockParser
{
/**
* pattern to detect tables
*/
private static final Pattern TABLE_PATTERN = Pattern.compile( "^\\s*([|].*[|])+\\s*$" );
/**
* text parser
*/
private FormatedTextParser textParser;
/** {@inheritDoc} */
public final boolean accept( final String line )
{
return TABLE_PATTERN.matcher( line ).lookingAt();
}
/**
* {@inheritDoc}
*/
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
if ( !accept( line ) )
{
throw new IllegalAccessError( "call accept before this ;)" );
}
final List rows = new ArrayList();
String l = line;
do
{
final Matcher m = TABLE_PATTERN.matcher( l );
if ( m.lookingAt() )
{
final List cells = new ArrayList();
/* for each cell... */
for ( int lh = l.indexOf( '|' ) + 1, rh; ( rh = l.indexOf( '|', lh ) ) != -1; lh = rh + 1 )
{
final Block[] bs = textParser.parse( l.substring( lh, rh ).trim() );
if ( bs.length == 1 && bs[0] instanceof BoldBlock )
{
final Block[] tmp = ( (BoldBlock) bs[0] ).getBlocks();
cells.add( new TableCellHeaderBlock( tmp ) );
}
else
{
cells.add( new TableCellBlock( bs ) );
}
}
rows.add( new TableRowBlock( (Block[]) cells.toArray( new Block[] {} ) ) );
}
}
while ( ( l = source.getNextLine() ) != null && accept( l ) );
assert rows.size() >= 1;
return new TableBlock( (Block[]) rows.toArray( new Block[] {} ) );
}
/**
* <p>Setter for the field <code>textParser</code>.</p>
*
* @param textParser text parser to be set
*/
public final void setTextParser( final FormatedTextParser textParser )
{
if ( textParser == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.textParser = textParser;
}
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/LinkBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000005315 11167436114 033404 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents a link.
*
* @author Juan F. Codagnone
* @version $Id: LinkBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class LinkBlock
implements Block
{
/**
* link reference
*/
private final String reference;
/**
* link text
*/
private final Block content;
/**
* Creates the LinkBlock.
*
* @param reference reference anchor
* @param text text to display
* @deprecated
*/
LinkBlock( final String reference, final String text )
{
this( reference, new TextBlock( text ) );
}
/**
* Creates the LinkBlock.
*
* @param reference reference anchor, not null.
* @param content block with the displayed content, not null.
*/
LinkBlock( final String reference, final Block content )
{
if ( reference == null || content == null )
{
throw new IllegalArgumentException( "arguments can't be null" );
}
this.reference = reference;
this.content = content;
}
/** {@inheritDoc} */
public final void traverse( final Sink sink )
{
sink.link( reference );
content.traverse( sink );
sink.link_();
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj instanceof LinkBlock )
{
final LinkBlock l = (LinkBlock) obj;
ret = reference.equals( l.reference ) && content.equals( l.content );
}
return ret;
}
/** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
final int magic2 = 37;
return magic1 + magic2 * reference.hashCode() + magic2 * content.hashCode();
}
}
././@LongLink 0000000 0000000 0000000 00000000167 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ItalicBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002736 11075462240 033405 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents the italic text format
*
* @author Juan F. Codagnone
* @version $Id: ItalicBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class ItalicBlock
extends AbstractFatherBlock
{
/**
* Creates the BoldBlock.
*
* @param childBlocks child blocks
*/
ItalicBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.italic();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.italic_();
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000003515 11102715517 033400 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Represents a table
*
* @author Juan F. Codagnone
* @version $Id: TableBlock.java 709605 2008-10-31 23:57:03Z hboutemy $
*/
class TableBlock
extends AbstractFatherBlock
{
/**
* Creates the TableBlock.
*
* @param childBlocks child blocks
*/
public TableBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.table();
sink.tableRows( getJustification(), false );
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.tableRows_();
sink.table_();
}
private int[] getJustification()
{
int[] justification = new int[( (AbstractFatherBlock) getBlocks()[0] ).getBlocks().length];
for ( int i = 0; i < justification.length; i++ )
{
justification[i] = Sink.JUSTIFY_CENTER;
}
return justification;
}
}
././@LongLink 0000000 0000000 0000000 00000000172 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002524 11167436114 033403 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @author Juan F. Codagnone
* @version $Id: ParagraphBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class ParagraphBlock
extends AbstractFatherBlock
{
ParagraphBlock( final Block[] blocks )
{
super( blocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.paragraph();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.paragraph_();
}
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002426 11167436114 033404 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* <pre>
* - item1
* - item2
* - item2.1
* ...
* </pre>
*
* @author Juan F. Codagnone
* @version $Id: ListBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
abstract class ListBlock
extends AbstractFatherBlock
{
/**
* Creates the ListBlock.
*
* @param blocks list of list items, not null.
*/
ListBlock( final ListItemBlock[] blocks )
{
super( blocks );
}
}
././@LongLink 0000000 0000000 0000000 00000000176 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/SectionBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000011412 11167436114 033377 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Parse looking for sections
*
* @author Juan F. Codagnone
* @version $Id: SectionBlockParser.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class SectionBlockParser
implements BlockParser
{
/**
* '---++ Header', '---## Header'
*/
private static final Pattern HEADER_DA = Pattern.compile( "^---([+]+)\\s*(.+)\\s*$" );
/**
* {@link ParagraphBlockParser} to use. injected
*/
private ParagraphBlockParser paraParser;
/**
* {@link ParagraphBlockParser} to use. injected
*/
private HRuleBlockParser hrulerParser;
/** {@link VerbatimBlockParser} */
private VerbatimBlockParser verbatimBlockParser;
/**
* {@inheritDoc}
*/
public final boolean accept( final String line )
{
return HEADER_DA.matcher( line ).lookingAt();
}
/**
* {@inheritDoc}
*/
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
final Matcher m = HEADER_DA.matcher( line );
if ( !m.lookingAt() )
{
throw new IllegalArgumentException( "don't know how to handle: " + line );
}
String newLine;
final ArrayList blocks = new ArrayList();
while ( ( newLine = source.getNextLine() ) != null && !accept( newLine ) )
{
if ( hrulerParser.accept( newLine ) )
{
blocks.add( hrulerParser.visit( newLine, source ) );
}
else
{
if ( verbatimBlockParser.accept( newLine ) )
{
blocks.add( verbatimBlockParser.visit( newLine, source ) );
}
else
{
blocks.add( paraParser.visit( newLine, source ) );
}
}
}
if ( newLine != null )
{
source.ungetLine();
}
return new SectionBlock( m.group( 2 ), getLevel( m.group( 1 ) ), (Block[]) blocks.toArray( new Block[] {} ) );
}
/**
* @param s "++"
* @return tha level of the section
* @throws IllegalArgumentException on error
*/
static int getLevel( final String s )
throws IllegalArgumentException
{
for ( int i = 0, n = s.length(); i < n; i++ )
{
if ( s.charAt( i ) != '+' )
{
throw new IllegalArgumentException( "the argument must have only" + " '+' characters" );
}
}
return s.length();
}
/**
* Sets the paraParser.
*
* @param paraParser <code>ParagraphBlockParser</code> with the paraParser.
*/
public final void setParaParser( final ParagraphBlockParser paraParser )
{
if ( paraParser == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.paraParser = paraParser;
}
/**
* Sets the hrulerParser.
*
* @param hrulerParser <code>HRuleBlockParser</code> with the hrulerParser.
*/
public final void setHrulerParser( final HRuleBlockParser hrulerParser )
{
if ( hrulerParser == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.hrulerParser = hrulerParser;
}
/**
* Sets the verbatimBlockParser.
*
* @param verbatimBlockParser <code>VerbatimBlockParser</code> with the verbatimBlockParser.
* @since 1.1
*/
public final void setVerbatimBlockParser( VerbatimBlockParser verbatimBlockParser )
{
if ( verbatimBlockParser == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.verbatimBlockParser = verbatimBlockParser;
}
}
././@LongLink 0000000 0000000 0000000 00000000171 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableRowBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002730 11075462240 033377 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Represens a Table Row
*
* @author Juan F. Codagnone
* @version $Id: TableRowBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class TableRowBlock
extends AbstractFatherBlock
{
/**
* Creates the TableRowBlock.
*
* @param childBlocks children blocks
*/
TableRowBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.tableRow();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.tableRow_();
}
}
././@LongLink 0000000 0000000 0000000 00000000167 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/BlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000003117 11216135717 033402 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Parse a twiki syntax block
*
* @author Juan F. Codagnone
* @version $Id: BlockParser.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public interface BlockParser
{
/**
* <p>accept.</p>
*
* @param line text line
* @return <code>true</code> if this class can handle this line
*/
boolean accept( String line );
/**
* <p>visit.</p>
*
* @param line a line of text
* @param source the source of lines
* @return a block
* @throws org.apache.maven.doxia.parser.ParseException on error
*/
Block visit( String line, ByLineSource source )
throws ParseException;
}
././@LongLink 0000000 0000000 0000000 00000000167 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/AnchorBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000004153 11167436114 033403 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Represents an anchor
*
* @author Juan F. Codagnone
* @version $Id: AnchorBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class AnchorBlock
implements Block
{
/**
* anchor name
*/
private final String name;
/**
* Creates the AnchorBlock.
*
* @param name name of the anchor, not null.
*/
AnchorBlock( final String name )
{
if ( name == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.name = name;
}
/** {@inheritDoc}*/
public final void traverse( final Sink sink )
{
sink.anchor( name );
sink.anchor_();
}
/** {@inheritDoc}*/
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj instanceof AnchorBlock )
{
final AnchorBlock a = (AnchorBlock) obj;
ret = name.equals( a.name );
}
return ret;
}
/** {@inheritDoc}*/
public final int hashCode()
{
return name.hashCode();
}
/** {@inheritDoc}*/
public String toString()
{
return name;
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/XHTMLBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000004213 11167436114 033400 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* An XHTML Block
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: XHTMLBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class XHTMLBlock
implements Block
{
private final String tag;
/**
* Creates the XHTMLBlock.
*
* @param tag the tag, eg: <pre>
* @throws IllegalArgumentException if the arguments are <code>null</code>
*/
XHTMLBlock( final String tag )
{
if ( tag == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.tag = tag;
}
/** {@inheritDoc}*/
public final void traverse( final Sink sink )
{
if ( tag.trim().length() == 0 )
{
return;
}
sink.rawText( tag );
}
/** {@inheritDoc}*/
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj instanceof XHTMLBlock )
{
final XHTMLBlock a = (XHTMLBlock) obj;
ret = tag.equals( a.tag );
}
return ret;
}
/** {@inheritDoc}*/
public final int hashCode()
{
return tag.hashCode();
}
}
././@LongLink 0000000 0000000 0000000 00000000174 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/HRuleBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000004515 11150514042 033372 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Block that represents an horizontal rule
*
* @author Juan F. Codagnone
* @version $Id: HRuleBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
*/
public class HRuleBlockParser
implements BlockParser
{
/**
* pattern used to detect horizontal rulers
*/
private static final Pattern HRULE_PATTERN = Pattern.compile( "^(---)(-*)(.*)$" );
/** {@inheritDoc} */
public final boolean accept( final String line )
{
final Matcher m = HRULE_PATTERN.matcher( line );
boolean ret = false;
if ( m.lookingAt() )
{
final int textGroup = 3;
String s = m.group( textGroup );
if ( s != null && !s.startsWith( "+" ) )
{
ret = true;
}
}
return ret;
}
/**
* {@inheritDoc}
*/
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
Block ret = new HorizontalRuleBlock();
final Matcher matcher = HRULE_PATTERN.matcher( line );
if ( matcher.lookingAt() )
{
final int textGroup = 3;
source.unget( matcher.group( textGroup ) );
}
else
{
throw new ParseException( "i was expecting a hruler!" );
}
return ret;
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TextParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000031422 11216135717 033402 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.List;
import java.util.StringTokenizer;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Parse almost plain text in search of WikiWords, links, ...
*
* @author Juan F. Codagnone
* @version $Id: TextParser.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public class TextParser
{
/**
* pattern to detect WikiWords
*/
private static final Pattern WIKIWORD_PATTERN =
Pattern.compile( "(!?([A-Z]\\w*[.])?([A-Z][a-z]+){2,}(#\\w*)?)" );
/**
* pattern to detect SpecificLinks links [[reference][text]]
*/
private static final Pattern SPECIFICLINK_PATTERN = Pattern.compile( "!?\\[\\[([^\\]]+)\\]\\[([^\\]]+)\\]\\]" );
/**
* pattern to detect ForcedLinks links [[reference asd]]
*/
private static final Pattern FORCEDLINK_PATTERN = Pattern.compile( "(!)?(\\[\\[(.+)\\]\\])" );
/**
* anchor name
*/
private static final Pattern ANCHOR_PATTERN = Pattern.compile( "#(([A-Z][A-Za-z]*){2,})" );
/**
* url word
*/
private static final Pattern URL_PATTERN = Pattern.compile( "(\\w+):[/][/][^\\s]*" );
/**
* image pattern specification
*/
private static final Pattern IMAGE_PATTERN = Pattern.compile( "(.*)\\.(png|jpg|gif|bmp)" );
/**
* image tag pattern specification (used for images at relative URLs)
*/
private static final Pattern IMAGE_TAG_PATTERN =
Pattern.compile( "<img\\b.*?\\bsrc=([\"'])(.*?)\\1.*>", Pattern.CASE_INSENSITIVE );
/** HTML tag pattern */
private static final Pattern HTML_TAG_PATTERN = Pattern.compile( "<(/?)([\\w]*)(.*?)(/?)>", Pattern.DOTALL );
/**
* resolves wikiWordLinks
*/
private final WikiWordLinkResolver wikiWordLinkResolver;
/** resolves noautolink tag */
private boolean noautolink;
/**
* Creates the TextParser.
*
* @param resolver resolver for wikiWord links
*/
public TextParser( final WikiWordLinkResolver resolver )
{
this.wikiWordLinkResolver = resolver;
}
/**
* <p>parse.</p>
*
* @param line line to parse
* @return a list of block that represents the input
*/
public final List parse( final String line )
{
final List ret = new ArrayList();
final Matcher linkMatcher = SPECIFICLINK_PATTERN.matcher( line );
final Matcher wikiMatcher = WIKIWORD_PATTERN.matcher( line );
final Matcher forcedLinkMatcher = FORCEDLINK_PATTERN.matcher( line );
final Matcher anchorMatcher = ANCHOR_PATTERN.matcher( line );
final Matcher urlMatcher = URL_PATTERN.matcher( line );
final Matcher imageTagMatcher = IMAGE_TAG_PATTERN.matcher( line );
final Matcher tagMatcher = HTML_TAG_PATTERN.matcher( line );
Matcher xhtmlMatcher = null;
if ( tagMatcher.find() )
{
String tag = tagMatcher.group( 2 );
Pattern pattern =
Pattern.compile( "(\\<" + tag + ".*\\>)(.*)?(\\<\\/" + tag + "\\>)(.*)?", Pattern.DOTALL );
xhtmlMatcher = pattern.matcher( line );
}
if ( xhtmlMatcher != null && xhtmlMatcher.find() )
{
parseXHTML( line, ret, xhtmlMatcher );
}
else if ( linkMatcher.find() )
{
parseLink( line, ret, linkMatcher );
}
else if ( wikiMatcher.find() && startLikeWord( wikiMatcher, line ) && !noautolink )
{
parseWiki( line, ret, wikiMatcher );
}
else if ( forcedLinkMatcher.find() )
{
parseForcedLink( line, ret, forcedLinkMatcher );
}
else if ( anchorMatcher.find() && isAWord( anchorMatcher, line ) )
{
parseAnchor( line, ret, anchorMatcher );
}
else if ( urlMatcher.find() && isAWord( urlMatcher, line ) )
{
parseUrl( line, ret, urlMatcher );
}
else if ( imageTagMatcher.find() )
{
parseImage( line, ret, imageTagMatcher );
}
else
{
if ( line.length() != 0 )
{
ret.add( new TextBlock( line ) );
}
}
return ret;
}
/**
* Parses the image tag
* @param line the line to parse
* @param ret where the results live
* @param imageTagMatcher image tag matcher
*/
private void parseImage( final String line, final List ret, final Matcher imageTagMatcher )
{
ret.addAll( parse( line.substring( 0, imageTagMatcher.start() ) ) );
final String src = imageTagMatcher.group( 2 );
ret.add( new ImageBlock( src ) );
ret.addAll( parse( line.substring( imageTagMatcher.end(), line.length() ) ) );
}
/**
* Parses the url
* @param line the line to parse
* @param ret where the results live
* @param urlMatcher url matcher
*/
private void parseUrl( final String line, final List ret, final Matcher urlMatcher )
{
ret.addAll( parse( line.substring( 0, urlMatcher.start() ) ) );
final String url = urlMatcher.group( 0 );
final Matcher imageMatcher = IMAGE_PATTERN.matcher( url );
if ( imageMatcher.matches() )
{
ret.add( new ImageBlock( url ) );
}
else
{
ret.add( new LinkBlock( url, new TextBlock( url ) ) );
}
ret.addAll( parse( line.substring( urlMatcher.end(), line.length() ) ) );
}
/**
* Parses the anchor
* @param line the line to parse
* @param ret where the results live
* @param anchorMatcher anchor matcher
*/
private void parseAnchor( final String line, final List ret, final Matcher anchorMatcher )
{
ret.addAll( parse( line.substring( 0, anchorMatcher.start() ) ) );
ret.add( new AnchorBlock( anchorMatcher.group( 1 ) ) );
ret.addAll( parse( line.substring( anchorMatcher.end(), line.length() ) ) );
}
/**
* Parses the link
* @param line line to parse
* @param ret where the results live
* @param forcedLinkMatcher forced link matcher
*/
private void parseForcedLink( final String line, final List ret, final Matcher forcedLinkMatcher )
{
if ( forcedLinkMatcher.group( 1 ) != null )
{
ret.add( new TextBlock( forcedLinkMatcher.group( 2 ) ) );
}
else
{
final String showText = forcedLinkMatcher.group( 3 );
// mailto link:
if ( showText.trim().startsWith( "mailto:" ) )
{
String s = showText.trim();
int i = s.indexOf( ' ' );
if ( i == -1 )
{
ret.add( new TextBlock( s ) );
}
else
{
ret.add( new LinkBlock( s.substring( 0, i ), new TextBlock( s.substring( i ).trim() ) ) );
}
}
else
{
ret.addAll( parse( line.substring( 0, forcedLinkMatcher.start() ) ) );
ret.add( createLink( showText, showText ) );
ret.addAll( parse( line.substring( forcedLinkMatcher.end(), line.length() ) ) );
}
}
}
/**
* Decides between a WikiWordBlock or a a LinkBlock
* @param link the link text
* @param showText the show text.
* @return either a WikiWordBlock or a LinkBlock
*/
private Block createLink( final String link, final String showText )
{
final Block content;
if ( URL_PATTERN.matcher( showText ).matches() && IMAGE_PATTERN.matcher( showText ).matches() )
{
content = new ImageBlock( showText );
}
else
{
content = new TextBlock( showText );
}
if ( URL_PATTERN.matcher( link ).matches() )
{
return new LinkBlock( link, content );
}
final StringTokenizer tokenizer = new StringTokenizer( link );
final StringBuffer sb = new StringBuffer();
while ( tokenizer.hasMoreElements() )
{
final String s = tokenizer.nextToken();
sb.append( s.substring( 0, 1 ).toUpperCase() );
sb.append( s.substring( 1 ) );
}
return new WikiWordBlock( sb.toString(), content, wikiWordLinkResolver );
}
/**
* Parses a wiki word
* @param line the line to parse
* @param ret where the results live
* @param wikiMatcher wiki matcher
*/
private void parseWiki( final String line, final List ret, final Matcher wikiMatcher )
{
final String wikiWord = wikiMatcher.group();
ret.addAll( parse( line.substring( 0, wikiMatcher.start() ) ) );
if ( wikiWord.startsWith( "!" ) )
{ // link prevention
ret.add( new TextBlock( wikiWord.substring( 1 ) ) );
}
else
{
ret.add( new WikiWordBlock( wikiWord, wikiWordLinkResolver ) );
}
ret.addAll( parse( line.substring( wikiMatcher.end(), line.length() ) ) );
}
/**
* Parses a link
* @param line the line to parse
* @param ret where the results live
* @param linkMatcher link matcher
*/
private void parseLink( final String line, final List ret, final Matcher linkMatcher )
{
ret.addAll( parse( line.substring( 0, linkMatcher.start() ) ) );
if ( line.charAt( linkMatcher.start() ) == '!' )
{
ret.add( new TextBlock( line.substring( linkMatcher.start() + 1, linkMatcher.end() ) ) );
}
else
{
ret.add( createLink( linkMatcher.group( 1 ), linkMatcher.group( 2 ) ) );
}
ret.addAll( parse( line.substring( linkMatcher.end(), line.length() ) ) );
}
/**
* Parses xhtml.
*
* @param line the line to parse
* @param ret where the results live
* @param xhtmlMatcher xhtml matcher
*/
private void parseXHTML( final String line, final List ret, final Matcher xhtmlMatcher )
{
if ( xhtmlMatcher.group( 1 ).indexOf( "noautolink" ) != -1 )
{
noautolink = true;
}
else
{
ret.add( new XHTMLBlock( xhtmlMatcher.group( 1 ) ) );
}
ret.addAll( parse( xhtmlMatcher.group( 2 ) ) );
if ( xhtmlMatcher.group( 1 ).indexOf( "noautolink" ) != -1 )
{
noautolink = false;
}
else
{
ret.add( new XHTMLBlock( xhtmlMatcher.group( 3 ) ) );
}
ret.addAll( parse( xhtmlMatcher.group( 4 ) ) );
}
/**
* @param m matcher to test
* @param line line to test
* @return <code>true</code> if the match on m represent a word (must be
* a space before the word or must be the beginning of the line)
*/
private boolean isAWord( final Matcher m, final String line )
{
return startLikeWord( m, line ) && endLikeWord( m, line );
}
/**
* @param m matcher to test
* @param line line to test
* @return true if it is the beginning of a word
*/
private boolean startLikeWord( final Matcher m, final String line )
{
final int start = m.start();
boolean ret = false;
if ( start == 0 )
{
ret = true;
}
else if ( start > 0 )
{
if ( isSpace( line.charAt( start - 1 ) ) )
{
ret = true;
}
}
return ret;
}
/**
* @param m matcher to test
* @param line line to test
* @return true if it is the end of a word
*/
private boolean endLikeWord( final Matcher m, final String line )
{
final int end = m.end();
boolean ret = true;
if ( end < line.length() )
{
ret = isSpace( line.charAt( end ) );
}
return ret;
}
/**
* @param c char to test
* @return <code>true</code> if c is a space char
*/
private boolean isSpace( final char c )
{
return c == ' ' || c == '\t';
}
}
././@LongLink 0000000 0000000 0000000 00000000172 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/TableCellBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002715 11075462240 033402 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Table cell
*
* @author Juan F. Codagnone
* @version $Id: TableCellBlock.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
class TableCellBlock
extends AbstractFatherBlock
{
/**
* Creates the TableCellBlock.
*
* @param childBlocks childrens
*/
TableCellBlock( final Block[] childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.tableCell();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
sink.tableCell_();
}
}
././@LongLink 0000000 0000000 0000000 00000000171 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ListItemBlock.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000006116 11167436114 033404 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Block that represents the item in a list
*
* @author Juan F. Codagnone
* @version $Id: ListItemBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class ListItemBlock
extends AbstractFatherBlock
{
private final ListBlock innerList;
/**
* @see #ListItemBlock(Block[], ListBlock)
*/
ListItemBlock( final Block[] blocks )
{
this( blocks, null );
}
/**
* Creates the ListItemBlock.
*
* @param blocks text block, not null.
* @param innerList child list
*/
ListItemBlock( final Block[] blocks, final ListBlock innerList )
{
super( blocks );
this.innerList = innerList;
}
/** {@inheritDoc} */
final void before( final Sink sink )
{
sink.listItem();
}
/** {@inheritDoc} */
final void after( final Sink sink )
{
if ( innerList != null )
{
innerList.traverse( sink );
}
sink.listItem_();
}
/**
* Returns the innerList.
*
* @return <code>UnorderedListBlock</code> with the innerList.
*/
final ListBlock getInnerList()
{
return innerList;
}
/** {@inheritDoc} */
public final boolean equals( final Object obj )
{
boolean ret = false;
if ( obj == this )
{
ret = true;
}
else if ( obj == null || this == null )
{
ret = false;
}
else if ( obj instanceof ListItemBlock )
{
final ListItemBlock li = (ListItemBlock) obj;
if ( this.innerList == null && li.innerList == null )
{
ret = super.equals( li );
}
else if ( this.innerList == null && li.innerList != null )
{
ret = false;
}
else
{
ret = this.innerList.equals( li.innerList ) && super.equals( li );
}
}
return ret;
}
/** {@inheritDoc} */
public final int hashCode()
{
final int magic1 = 17;
final int magic2 = 37;
return magic1 + magic2 * super.hashCode() + ( innerList == null ? 0 : magic2 * innerList.hashCode() );
}
}
././@LongLink 0000000 0000000 0000000 00000000200 00000000000 011555 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/ParagraphBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000016424 11150514042 033374 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* Parse paragraphs.
*
* @author Juan F. Codagnone
* @version $Id: ParagraphBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
*/
public class ParagraphBlockParser
implements BlockParser
{
/**
* pattern used to dectect end of paragraph
*/
private final Pattern paragraphSeparator = Pattern.compile( "^(\\s*)$" );
/**
* {@link SectionBlockParser} to use. injected
*/
private SectionBlockParser sectionParser;
/**
* {@link ListBlockParser} to use. injected
*/
private GenericListBlockParser listParser;
/**
* {@link FormatedTextParser} to use. injected
*/
private FormatedTextParser textParser;
/**
* {@link HRuleBlockParser} to use. injected
*/
private HRuleBlockParser hrulerParser;
/**
* {@link TableBlockParser} to use. injected
*/
private TableBlockParser tableBlockParser;
/**
* {@link TableBlockParser} to use. injected
*/
private VerbatimBlockParser verbatimParser;
/**
* no operation block
*/
private static final NopBlock NOP = new NopBlock();
/** {@inheritDoc} */
public final boolean accept( final String line )
{
return !sectionParser.accept( line ) && !hrulerParser.accept( line ) && !verbatimParser.accept( line );
}
/**
* {@inheritDoc}
*/
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
StringBuffer sb = new StringBuffer();
List childs = new ArrayList();
boolean sawText = false;
/*
* 1. Skip begininig new lines
* 2. Get the text, while \n\n is not found
*/
boolean pre = false;
String l = line;
do
{
Matcher m = paragraphSeparator.matcher( l );
if ( m.lookingAt() )
{
if ( sawText )
{
break;
}
}
else
{
sawText = true;
/* be able to parse lists / enumerations */
if ( listParser.accept( l ) )
{
if ( sb.length() != 0 )
{
childs.addAll( Arrays.asList( textParser.parse( sb.toString().trim() ) ) );
sb = new StringBuffer();
}
childs.add( listParser.visit( l, source ) );
}
else if ( tableBlockParser.accept( l ) )
{
childs.add( tableBlockParser.visit( l, source ) );
}
else
{
sb.append( l );
// specific
if ( l.indexOf( "<pre>" ) != -1 )
{
pre = true;
}
if ( l.indexOf( "</pre>" ) != -1 )
{
pre = false;
}
if ( !pre )
{
sb.append( " " );
}
else
{
// TODO use EOL
sb.append( "\n" );
}
}
}
l = source.getNextLine();
}
while ( l != null && accept( l ) );
if ( line != null )
{
source.ungetLine();
}
if ( sb.length() != 0 )
{
childs.addAll( Arrays.asList( textParser.parse( sb.toString().trim() ) ) );
sb = new StringBuffer();
}
if ( childs.size() == 0 )
{
return NOP;
}
return new ParagraphBlock( (Block[]) childs.toArray( new Block[] {} ) );
}
/**
* Sets the sectionParser.
*
* @param aSectionParser <code>SectionBlockParser</code> with the sectionParser.
*/
public final void setSectionParser( final SectionBlockParser aSectionParser )
{
if ( aSectionParser == null )
{
throw new IllegalArgumentException( "arg can't be null" );
}
this.sectionParser = aSectionParser;
}
/**
* Sets the listParser.
*
* @param aListParser <code>ListBlockParser</code> with the listParser.
*/
public final void setListParser( final GenericListBlockParser aListParser )
{
if ( aListParser == null )
{
throw new IllegalArgumentException( "arg can't be null" );
}
this.listParser = aListParser;
}
/**
* Sets the formatTextParser.
*
* @param aTextParser <code>FormatedTextParser</code>
* with the formatTextParser.
*/
public final void setTextParser( final FormatedTextParser aTextParser )
{
if ( aTextParser == null )
{
throw new IllegalArgumentException( "arg can't be null" );
}
this.textParser = aTextParser;
}
/**
* Sets the hrulerParser.
*
* @param aHrulerParser <code>HRuleBlockParser</code> with the hrulerParser.
*/
public final void setHrulerParser( final HRuleBlockParser aHrulerParser )
{
if ( aHrulerParser == null )
{
throw new IllegalArgumentException( "arg can't be null" );
}
this.hrulerParser = aHrulerParser;
}
/**
* <p>Setter for the field <code>tableBlockParser</code>.</p>
*
* @param aTableBlockParser Table parser to use
*/
public final void setTableBlockParser( final TableBlockParser aTableBlockParser )
{
if ( aTableBlockParser == null )
{
throw new IllegalArgumentException( "arg can't be null" );
}
this.tableBlockParser = aTableBlockParser;
}
/**
* Sets the verbatimParser.
*
* @param aVerbatimParser <code>VerbatimBlockParser</code> with the verbatimParser.
* @since 1.1
*/
public final void setVerbatimParser( final VerbatimBlockParser aVerbatimParser )
{
if ( aVerbatimParser == null )
{
throw new IllegalArgumentException( "arg can't be null" );
}
this.verbatimParser = aVerbatimParser;
}
}
././@LongLink 0000000 0000000 0000000 00000000202 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/GenericListBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000033320 11150514042 033366 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
/**
* Generic list parser
*
* @author Juan F. Codagnone
* @version $Id: GenericListBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
*/
public class GenericListBlockParser
implements BlockParser
{
static final String EOL = System.getProperty( "line.separator" );
/**
* parser used to create text blocks
*/
private FormatedTextParser formatedTextParser;
/**
* supported patterns
*/
private final Pattern[] patterns = new Pattern[TYPES.length];
/**
* Creates the GenericListBlockParser.
*/
public GenericListBlockParser()
{
for ( int i = 0; i < TYPES.length; i++ )
{
patterns[i] = Pattern.compile( "^(( )+)" + TYPES[i].getItemPattern() + "(.*)$" );
}
}
/** {@inheritDoc} */
public final boolean accept( final String line )
{
boolean ret = false;
for ( int i = 0; !ret && i < patterns.length; i++ )
{
ret |= patterns[i].matcher( line ).lookingAt();
}
return ret;
}
/**
* {@inheritDoc}
*/
public final Block visit( final String line, final ByLineSource source )
throws ParseException
{
final TreeListBuilder treeListBuilder = new TreeListBuilder( formatedTextParser );
// new TreeListBuilder(formatedTextParser);
String l = line;
do
{
if ( !accept( l ) )
{
break;
}
for ( int i = 0; i < patterns.length; i++ )
{
final Matcher m = patterns[i].matcher( l );
if ( m.lookingAt() )
{
final int numberOfSpaces = 3;
final int textGroup = 3;
assert m.group( 1 ).length() % numberOfSpaces == 0;
final int level = m.group( 1 ).length() / numberOfSpaces;
treeListBuilder.feedEntry( TYPES[i], level, m.group( textGroup ).trim() );
break;
}
}
}
while ( ( l = source.getNextLine() ) != null );
if ( l != null )
{
source.ungetLine();
}
return treeListBuilder.getBlock();
}
/**
* Sets the formatTextParser.
*
* @param textParser <code>FormatedTextParser</code> with the formatTextParser.
*/
public final void setTextParser( final FormatedTextParser textParser )
{
if ( textParser == null )
{
throw new IllegalArgumentException( "formatTextParser can't be null" );
}
this.formatedTextParser = textParser;
}
interface Type
{
/**
* @return the pattern of the item part of the list regex
*/
String getItemPattern();
/**
* @param items children of the new listblock
* @return a new ListBlock
*/
ListBlock createList( final ListItemBlock[] items );
}
/**
* unordered list
*/
private static final Type LIST = new Type()
{
/** {@inheritDoc} */
public String getItemPattern()
{
return "[*]";
}
/** {@inheritDoc} */
public ListBlock createList( final ListItemBlock[] items )
{
return new UnorderedListBlock( items );
}
};
/**
* a.
*/
private static final Type ORDERED_LOWER_ALPHA = new Type()
{
/** {@inheritDoc} */
public String getItemPattern()
{
return "[a-hj-z][.]";
}
/** {@inheritDoc} */
public ListBlock createList( final ListItemBlock[] items )
{
return new NumeratedListBlock( Sink.NUMBERING_LOWER_ALPHA, items );
}
};
/**
* A.
*/
private static final Type ORDERED_UPPER_ALPHA = new Type()
{
/** {@inheritDoc} */
public String getItemPattern()
{
return "[A-HJ-Z][.]";
}
/** {@inheritDoc} */
public ListBlock createList( final ListItemBlock[] items )
{
return new NumeratedListBlock( Sink.NUMBERING_UPPER_ALPHA, items );
}
};
/**
* 1.
*/
private static final Type ORDERERED_DECIMAL = new Type()
{
/** {@inheritDoc} */
public String getItemPattern()
{
return "[0123456789][.]";
}
/** {@inheritDoc} */
public ListBlock createList( final ListItemBlock[] items )
{
return new NumeratedListBlock( Sink.NUMBERING_DECIMAL, items );
}
};
/**
* i.
*/
private static final Type ORDERERED_LOWER_ROMAN = new Type()
{
/** {@inheritDoc} */
public String getItemPattern()
{
return "[i][.]";
}
/** {@inheritDoc} */
public ListBlock createList( final ListItemBlock[] items )
{
return new NumeratedListBlock( Sink.NUMBERING_LOWER_ROMAN, items );
}
};
/**
* I.
*/
private static final Type ORDERERED_UPPER_ROMAN = new Type()
{
/** {@inheritDoc} */
public String getItemPattern()
{
return "[I][.]";
}
/** {@inheritDoc} */
public ListBlock createList( final ListItemBlock[] items )
{
return new NumeratedListBlock( Sink.NUMBERING_UPPER_ROMAN, items );
}
};
private static final Type[] TYPES =
{ LIST, ORDERED_LOWER_ALPHA, ORDERED_UPPER_ALPHA, ORDERERED_DECIMAL, ORDERERED_LOWER_ROMAN,
ORDERERED_UPPER_ROMAN };
}
/**
* It helps to build
*
* @author Juan F. Codagnone
* @version $Id: GenericListBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
*/
class TreeListBuilder
{
/**
* parser that create text blocks
*/
private final FormatedTextParser textParser;
/**
* tree root
*/
private final TreeComponent root;
/**
* the current element of the tree
*/
private TreeComponent current;
/**
* Creates the TreeListBuilder.
*
* @param formatTextParser parser that create text blocks
* @throws IllegalArgumentException if <code>formatTextParser</code> is null
*/
TreeListBuilder( final FormatedTextParser formatTextParser )
throws IllegalArgumentException
{
if ( formatTextParser == null )
{
throw new IllegalArgumentException( "argument is null" );
}
this.textParser = formatTextParser;
root = new TreeComponent( null, "root", null );
current = root;
}
/**
* recibe un nivel y un texto y armar magicamente (manteniendo estado)
* el �rbol
*
* @param type type of list
* @param level indentation level of the item
* @param text text of the item
*/
void feedEntry( final GenericListBlockParser.Type type, final int level, final String text )
{
final int currentDepth = current.getDepth();
final int incomingLevel = level - 1;
if ( incomingLevel == currentDepth )
{
// nothing to move
}
else if ( incomingLevel > currentDepth )
{
// el actual ahora es el �ltimo que insert�
final TreeComponent[] components = current.getChildren();
if ( components.length == 0 )
{
/* for example:
* * item1
* * item2
*/
for ( int i = 0, n = incomingLevel - currentDepth; i < n; i++ )
{
current = current.addChildren( "", type );
}
}
else
{
current = components[components.length - 1];
}
}
else
{
for ( int i = 0, n = currentDepth - incomingLevel; i < n; i++ )
{
current = current.getFather();
if ( current == null )
{
throw new IllegalStateException();
}
}
}
current.addChildren( text, type );
}
/**
* @return a Block for the list that we received
*/
ListBlock getBlock()
{
return getList( root );
}
/**
* Wrapper
*
* @param tc tree
* @return list Block for this tree
*/
private ListBlock getList( final TreeComponent tc )
{
ListItemBlock[] li = (ListItemBlock[]) getListItems( tc ).toArray( new ListItemBlock[] {} );
return tc.getChildren()[0].getType().createList( li );
}
/**
* @param tc tree
* @return list Block for this tree
*/
private List getListItems( final TreeComponent tc )
{
final List blocks = new ArrayList();
for ( int i = 0; i < tc.getChildren().length; i++ )
{
final TreeComponent child = tc.getChildren()[i];
Block[] text = new Block[] {};
if ( child.getFather() != null )
{
text = textParser.parse( child.getText() );
}
if ( child.getChildren().length != 0 )
{
blocks.add( new ListItemBlock( text, getList( child ) ) );
}
else
{
blocks.add( new ListItemBlock( text ) );
}
}
return blocks;
}
/**
* A bidirectional tree node
*
* @author Juan F. Codagnone
* @version $Id: GenericListBlockParser.java 746991 2009-02-23 12:35:46Z vsiveton $
*/
class TreeComponent
{
/**
* childrens
*/
private List children = new ArrayList();
/**
* node text
*/
private String text;
/**
* the father
*/
private TreeComponent father;
/**
* type of the list
*/
private GenericListBlockParser.Type type;
/**
* Creates the TreeComponent.
*
* @param father Component father
* @param text component text
* @param type component type
*/
TreeComponent( final TreeComponent father, final String text, final GenericListBlockParser.Type type )
{
this.text = text;
this.father = father;
this.type = type;
}
/**
* @return my childrens
*/
TreeComponent[] getChildren()
{
return (TreeComponent[]) children.toArray( new TreeComponent[] {} );
}
/**
* adds a children node
*
* @param t text of the children
* @param ttype component type
* @return the new node created
*/
TreeComponent addChildren( final String t, final GenericListBlockParser.Type ttype )
{
if ( t == null || ttype == null )
{
throw new IllegalArgumentException( "argument is null" );
}
final TreeComponent ret = new TreeComponent( this, t, ttype );
children.add( ret );
return ret;
}
/**
* @return the father
*/
TreeComponent getFather()
{
return father;
}
/**
* @return the node depth in the tree
*/
int getDepth()
{
int ret = 0;
TreeComponent c = this;
while ( ( c = c.getFather() ) != null )
{
ret++;
}
return ret;
}
/** {@inheritDoc} */
public String toString()
{
return toString( "" );
}
/** {@inheritDoc} */
public String toString( final String indent )
{
final StringBuffer sb = new StringBuffer();
if ( father != null )
{
sb.append( indent );
sb.append( "- " );
sb.append( text );
sb.append( GenericListBlockParser.EOL );
}
for ( Iterator it = children.iterator(); it.hasNext(); )
{
TreeComponent lc = (TreeComponent) it.next();
sb.append( lc.toString( indent + " " ) );
}
return sb.toString();
}
/**
* Returns the text.
*
* @return <code>String</code> with the text.
*/
String getText()
{
return text;
}
/**
* Returns the type.
*
* @return <code>Type</code> with the text.
*/
GenericListBlockParser.Type getType()
{
return type;
}
}
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parser/Block.java doxia-1.1.4/doxia-modules/doxia-module-twiki/src/main/java/org/apache/maven/doxia/module/twiki/parse0000644 0001750 0001750 00000002445 11075462240 033402 0 ustar twerner twerner package org.apache.maven.doxia.module.twiki.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* Document objet model: we parse the document to a bunch of these.
* <p/>
* Implementators should implement equals() and hashCode() to ease testing
*
* @author Juan F. Codagnone
* @version $Id: Block.java 705065 2008-10-15 21:46:08Z vsiveton $
*/
public interface Block
{
/**
* Traverse the block
*
* @param sink the sink that travers
*/
void traverse( final Sink sink );
}
doxia-1.1.4/doxia-modules/pom.xml 0000644 0001750 0001750 00000004501 11470562366 016660 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
--><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia</artifactId>
<groupId>org.apache.maven.doxia</groupId>
<version>1.1.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>doxia-modules</artifactId>
<name>Doxia :: Modules</name>
<packaging>pom</packaging>
<description>Doxia modules for several markup languages.</description>
<modules>
<module>doxia-module-apt</module>
<module>doxia-module-confluence</module>
<module>doxia-module-docbook-simple</module>
<module>doxia-module-fml</module>
<module>doxia-module-fo</module>
<module>doxia-module-itext</module>
<module>doxia-module-latex</module>
<module>doxia-module-rtf</module>
<module>doxia-module-twiki</module>
<module>doxia-module-xdoc</module>
<module>doxia-module-xhtml</module>
</modules>
<dependencies>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-core</artifactId>
</dependency>
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-sink-api</artifactId>
</dependency>
<!-- test -->
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-core</artifactId>
<type>test-jar</type>
<scope>test</scope>
</dependency>
</dependencies>
</project>
doxia-1.1.4/doxia-modules/doxia-module-confluence/ 0000755 0001750 0001750 00000000000 11632765557 022060 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/pom.xml 0000644 0001750 0001750 00000003623 11470562366 023372 0 ustar twerner twerner <!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia-modules</artifactId>
<groupId>org.apache.maven.doxia</groupId>
<version>1.1.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>doxia-module-confluence</artifactId>
<name>Doxia :: Confluence Module</name>
<description>A Doxia module for Confluence source documents.</description>
<dependencies>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>
</dependencies>
<developers>
<developer>
<name>Juan F. Codagnone</name>
<email>juan *at* zauber dot. com dot. ar</email>
<roles>
<role>Developer</role>
</roles>
<timezone>-3</timezone>
</developer>
<developer>
<name>Jason van Zyl</name>
<roles>
<role>Developer</role>
</roles>
<timezone>-5</timezone>
</developer>
</developers>
</project>
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/ 0000755 0001750 0001750 00000000000 11632765557 022647 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/ 0000755 0001750 0001750 00000000000 11632765557 023626 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/site/ 0000755 0001750 0001750 00000000000 11632765557 024572 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/site/confluence/ 0000755 0001750 0001750 00000000000 11632765557 026713 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/site/confluence/page.confluence 0000644 0001750 0001750 00000003254 10524215463 031657 0 ustar twerner twerner This the way that we would like to *translate* sites that are primarily
authored in confluence while at the same time having the site be rendered in
a _standard way on a static website_.
----
Here is a link to [JIRA|http://jira.codehaus.org]
Here is a link with no text [http://jira.codehaus.org]
This is some {{monospaced}} text.
* item one
** foo
** bar
* item two
* item three
Some more text
# number one
# number two
# number three
||one||two||three||
|foo|bar|baz|
h1. I am h1
this is how you would code a mojo!
{code}
public class MyMojo
extends AbstractMojo
{
/**
* @parameter expression="${plugin.artifacts}"
* @required
*/
private List pluginArtifacts;
public void execute()
throws MojoExecutionException
{
...
for ( Iterator i = pluginArtifacts.iterator(); i.hasNext(); )
{
Artifact pluginArtifact = (Artifact) i.next();
}
...
}
}
{code}
h2. I am h2
this is the way of the world
{noformat}
public class MyMojo
extends AbstractMojo
{
/**
* @parameter expression="${plugin.artifacts}"
* @required
*/
private List pluginArtifacts;
public void execute()
throws MojoExecutionException
{
...
for ( Iterator i = pluginArtifacts.iterator(); i.hasNext(); )
{
Artifact pluginArtifact = (Artifact) i.next();
}
...
}
}
{noformat}
h3. I am h3
this is the way of the world
h4. I am h4
this is the way of the world
h5. I am h5
this is the way of the world
h1. Answered Questions
h3. What can I do to get the Maven love?
Well, you just have to be calm and the maven love will come your way.
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/site/confluence/faq.confluence 0000644 0001750 0001750 00000023676 10524215463 031524 0 ustar twerner twerner *NOTE:* _This page contains drafts of user contributed FAQ entries. The content you see here might not be fully fool-proof or might not comply with the best practices promoted by Maven. What is only guaranteed is that they have worked once for some members. It is best to treat these items as "works in progress" until they have been reviewed and promoted to the main Maven documentation site._
Users may also list questions here that they would like answered. So this page can serve as a collection of questions that users would like answered. Please put unanswered questions at the bottom. Please follow the format that is being used because it will help in our automated exaction of material which can then be incorporated into the main site.
h1. Answered Questions
h3. Why am I getting a "<plugin name> does not exist or no valid version" error?
This means that Maven is unable to access the required plugin from your local repository, and unable to access the official or 'central' Maven2 plugin repository.
You may troubleshoot the problem by performing the following actions:
# If you are behind a http proxy, please check the Maven2 [proxy settings guide|http://maven.apache.org/guides/mini/guide-proxies.html].
# If the plugin you seek cannot be redistributed freely then you may [add it manually to your repository|http://maven.apache.org/guides/mini/guide-coping-with-sun-jars.html].
If the problem still persists you may seek help from the Maven user list, browse [archived discussions|http://www.mail-archive.com/users@maven.apache.org/], or log a [ticket|http://jira.codehaus.org/browse/MNG] describing your problem if you think you have found a bug. Tickets could also be issued for feature enhancement requests, and other tasks.
h3. How do I install a file in my local repository along with a generic Pom?
This solution requires at least 2.0.1-SNAPSHOT or above version of Maven 2. You may do this by typing this command (please take note that this is a single line only).
{code}
mvn install:install-file
-DgroupId=<group-id>
-DartifactId=<artifact-id>
-Dversion=<version>
-Dfile=<path-to-file>
-Dpackaging=<packaging> (i.e. jar)
-DgeneratePom=true
{code}
This command installs the jar in your local repository with the generated generic pom.
h3. How do I install a file in my local repository along with my customed Pom?
The solution requires at least 2.0.1-SNAPSHOT or above version of Maven 2 and add the -DpomFile=<path-to-pom> parameter just like the sample below.
{code}
mvn install:install-file
-DgroupId=<group-id>
-DartifactId=<artifact-id>
-Dversion=<version>
-Dfile=<path-to-file>
-Dpackaging=<packaging> (i.e. jar)
-DpomFile=<path-to-pom>
{code}
This command will install the file in your local repository along with your customed pom.
h3. Are there any ways of including/excluding the other modules in the navigation menu in the parent site?
[http://jira.codehaus.org/browse/MNG-661], provides a simple patch which provides parent and module links using the project URLs which as you
correctly point out only work when the site is deployed.
h3. Where is the ______ plugin?
If you cannot find a certain plugin, you may want to take a look on the following sites.
# http://mojo.codehaus.org
# https://svn.codehaus.org/mojo/trunk/mojo
# https://svn.codehaus.org/mojo/trunk/mojo/mojo-sandbox
h3. Why are there no pre/post goals in Maven 2.x?
In Maven 1.x, pre/postGoals were used to inject custom behavior to the build process. This caused a problem, since declaring your code to be a preGoal of some other goal meant that you depended on that specific goal, rather than the work it did. It also caused confusion when trying to inject other behavior into a build that already had pre/postGoals attached: Where would the new behavior be injected?.
Pre- and post-goals in Maven 1.x were usually used to develop the concept of a workflow, or lifecycle, for the build, where *x* happened before *y*, which had to happen before the sources could be compiled. In Maven 2, we've incorporated this concept of a build lifecycle natively. The steps - or phases - in this lifecycle correspond to the types of actions that might occur in a build. Your plugin can declare which type of action it performs - or which phase it should bind to - and that will guarantee it is executed before the next action type. For example, if your plugin generates some source code, you might want it to bind to the "generate-sources" lifecycle phase, so it is guaranteed to run before the "compile" phase.
For more information, see:
* [Introduction to the Build Lifecycle|http://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html]
h3. How does Maven compare with Ivy?
For a comparison of Maven's features vs Ivy's you can refer to our [feature comparison|http://docs.codehaus.org/display/MAVEN/Feature+Comparisons]
h3. How do I get the dependencies of a plug-in from within a Mojo?
{code}
public class MyMojo
extends AbstractMojo
{
/**
* @parameter expression="${plugin.artifacts}"
* @required
*/
private List pluginArtifacts;
public void execute()
throws MojoExecutionException
{
...
for ( Iterator i = pluginArtifacts.iterator(); i.hasNext(); )
{
Artifact pluginArtifact = (Artifact) i.next();
}
...
}
}
{code}
h3. How do I get the sources for a project within a Mojo?
{code}
public class MyMojo
extends AbstractMojo
{
/**
* @parameter expression="${project.compileSourceRoots}"
* @required
*/
private List sourceRoots;
public void execute()
throws MojoExecutionException
{
...
for ( Iterator i = sourceRoots.iterator(); i.hasNext(); )
{
String sourceRoot = (String) i.next();
// Do what you want with these directories
}
}
}
{code}
h3. How do I use SNAPSHOT versions of plug-ins?
The POM is meant to be current state, not history. We actually only record the versions in the repository, and if the SCM tag is populated in the <scm> section of the POM for each released version you can reconstruct the information.
There were other issues with putting history in the POM: forgetting to add it, getting the right level of information when you work on multiple branches, and similar things.
h3. How do I create a report that does not require using Doxia's Sink interface?
Make it a report and override the isExternalReport() method to return true. Then you don't need to use the Sink at all.
h3. Is it possible to prevent warnings from a custom repository?
Warnings from custom repositories (usually located within the organization's network, or even on the same workstation) are triggered when Maven tries to verify the integrity of the files in the repository. This verification is done via the SHA1 or MD5 sum of the file. If these sum files do not exist then a warning is shown.
Support for downloading the the security sum files is not yet included in the Maven2 distribution. There are free command-line utilities on the Internet that generate these sums. Below is an example of a bash script (use [Cygwin|http://cygwin.com] if you are using a windows machine) that generates sha1sum for all jar, xml and pom files contained in the directory where it is executed:
{code}
#!/usr/bin/bash
gensum(){
shaname=$1.sha1
sum=`sha1sum $1 | cut -f1 -d" "`
echo $sum > $shaname
}
processFile(){
while read oneline
do
gensum $oneline
done < "$1"
}
tmpFile=$TMP/shagen.list
echo "Generating sha1 sums for XML files"
find . -name "*.xml" > "$tmpFile"
processFile "$tmpFile"
echo "Generating sha1 sums for POM files"
find . -name "*.pom" > "$tmpFile"
processFile "$tmpFile"
echo "Generating sha1 sums for JAR files"
find . -name "*.jar" > "$tmpFile"
processFile "$tmpFile"
rm "$tmpFile"
{code}
The script above has been tested on [Cygwin|http://cygwin.com] and is provided as is and with no guarantee.
h3. Why am I getting the following error when I run the <plugin_name>: "ERROR: Cannot override read-only parameter: <parameter_name>"?
This means that the parameter you are overriding in your pom.xml is readonly. Hence, it is not possible to override this parameter.
h3. The sites of the plugins of Maven have a page with an overview of the goals and the parameters of the plugin. How is this generated?
Include maven-plugin-plugin as a report.
h3. how can I define the antrun plugin to be executed on demand like "mvn antrun:run"?
This isn't actually possible with the plugin, unless perhaps you do this:
- put everything in a top level configuration of the plugin
- pass in a variable from the command line, eg -Dtarget=foo antrun:run
- execute the appropriate target in the script based on the variable
Ideally, you would write a plugin for these goals (Ant support for
plugins will be available soon, currently you must write them in java
or beanshell).
h3. When I extend a mojo from another plugin, it's variables are not properly populated. Why?
The field metadata when creating plugins is read from source files, so is not available when the original source is not. The metadata is available in the plugin in {{META-INF/maven/plugin.xml}}, but at this point there is no way to incorporate it when building a new plugin.
We currently recommend building your plugins using composition instead of inheritence.
h1. Unanswered Questions
h3. Where can I find a listing of the available variable references that could be use during site generation?
h3. How do I generate sources with the antrun plug-in?
h3. Can I disable transitive dependencies?
h3. How do I run a shell script from inside a Mojo?
h3. Are resources inherited in the POM?
h3. Why is there no <versions/> element in the v4.0.0 POMs?
h3. How do I find the stale resources in a Mojo to avoid reprocessing them?
h3. Will the release plug-in resolve all my SNAPSHOT dependencies?
h3. How do I integrate static (x)html into my Maven site?
h3. Where did the properties files go for plug-in configuration in Maven 1.x?
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765557 025640 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/paragraph-list.confluence 0000644 0001750 0001750 00000000144 10713410027 032572 0 ustar twerner twerner
A paragraph
* A nested list item
* Another nested list item
with two lines
Back at the top level
././@LongLink 0000000 0000000 0000000 00000000151 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/nested-list-heterogenous.confluence doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/nested-list-heterogenous.conflu0000644 0001750 0001750 00000000151 11201210615 033751 0 ustar twerner twerner * A top level list item
*# A nested list item
*# Another nested list item
* Back at the top level
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/figure.confluence 0000644 0001750 0001750 00000000556 11165340254 031152 0 ustar twerner twerner Simple paragraph.
!images/photo.jpg!
Simple paragraph with attempted inline !image.jpg! (should fail).
!images/photo.jpg! With caption on same line
!images/linebreak.jpg!\\
With caption underneath and linebreak
!images/nolinebreak.jpg!
With caption underneath and no linebreak
!images/bold.jpg!
With *bold* caption underneath
!image.gif|align=right, vspace=4! doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/table-link.confluence 0000644 0001750 0001750 00000000473 11201107013 031672 0 ustar twerner twerner || Version || Download || Format ||
|0.1.1 |[Download|http://example.com/release.0.1.1/ex-win32-win32.x86.zip]| 12-12-2008 | zip |
|0.1.2 |[http://example.com/release.0.1.2/ex-win32-win32.x86.zip]| 04-12-2008 | zip |
|0.1.3 |[Download|http://example.com/release.0.1.3/ex-win32-win32.x86.zip]| 03-11-2008 | zip | doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/linebreak.confluence 0000644 0001750 0001750 00000000055 10710327724 031621 0 ustar twerner twerner Line\\
break.
Line\\with 2\\inline\\
Breaks. doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/simple-list.confluence 0000644 0001750 0001750 00000000467 11165353003 032130 0 ustar twerner twerner * Simple paragraph with *bold* and _italic_ text.
* Here is a link to [JIRA|http://jira.codehaus.org]
* Here is a link with no text [http://jira.codehaus.org]
* This is some {{monospaced}} text.
* Item with no formatting
Paragraph
* One bullet
* A list item with
more than one line
*bold text, not a list!* doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/anchor.confluence 0000644 0001750 0001750 00000000164 10711435127 031136 0 ustar twerner twerner h1. Section Title
{anchor:start}Simple paragraph.
Simple paragraph{anchor:end}
Simple {anchor:middle} paragraph.
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/link.confluence 0000644 0001750 0001750 00000000163 10713271224 030616 0 ustar twerner twerner Line with [middle] link
Line with link at the [end]
Line with [link#anchor] and [#simple] anchor and [alias|link] doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/paragraph-figure.confluence 0000644 0001750 0001750 00000000100 10713410027 033070 0 ustar twerner twerner
A paragraph
!images/logo.png!
with a figure
Another paragraph
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/unknown-macro.confluence 0000644 0001750 0001750 00000000145 10711163047 032460 0 ustar twerner twerner {unknown:start}Simple paragraph.
Simple paragraph{unknown:end}.
Simple {unknown:middle} paragraph.
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/table.confluence 0000644 0001750 0001750 00000000721 11167062617 030760 0 ustar twerner twerner
Simple table:
||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|
Table with links (DOXIA-301):
|| Version || Download || Date || Format ||
|0.1.1 | [Download|http://example.com/release.0.1.1/ex-win32-win32.x86.zip] | 12-12-2008 | zip |
|0.1.2 | [Download|http://example.com/release.0.1.2/ex-win32-win32.x86.zip] | 04-12-2008 | zip |
|0.1.3 | [Download|http://example.com/release.0.1.3/ex-win32-win32.x86.zip] | 03-11-2008 | zip | doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/nested-format.confluence 0000644 0001750 0001750 00000000222 10720263577 032437 0 ustar twerner twerner
A paragraph with *_bold italic_* _*italic bold*_ *{{bold monospaced}}*
A paragraph with *bold _italic_* _italic *bold*_ *bold {{monospaced}}*
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/code.confluence 0000644 0001750 0001750 00000000641 11165345361 030602 0 ustar twerner twerner Simple paragraph.
{code:title=Cat.java}
public class Cat {
public void sitOn(Mat mat) {
// ... code here <angle brackets>
}
}
{code}
Another paragraph (the title of the code block is ignored).
Simple paragraph with embedded code
{code}
public class Cat {
public void sitOn(Mat mat) {
// ... code here <angle brackets>
}
}
{code}
in the same paragraph (this didn't work until DOXIA-181). See also DOXIA-302. doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/nested-list.confluence 0000644 0001750 0001750 00000000161 10711100347 032105 0 ustar twerner twerner
A paragraph
* A top level list item
** A nested list item
** Another nested list item
* Back at the top level
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/test.confluence 0000644 0001750 0001750 00000003254 10662577701 030660 0 ustar twerner twerner This the way that we would like to *translate* sites that are primarily
authored in confluence while at the same time having the site be rendered in
a _standard way on a static website_.
----
Here is a link to [JIRA|http://jira.codehaus.org]
Here is a link with no text [http://jira.codehaus.org]
This is some {{monospaced}} text.
* item one
** foo
** bar
* item two
* item three
Some more text
# number one
# number two
# number three
||one||two||three||
|foo|bar|baz|
h1. I am h1
this is how you would code a mojo!
{code}
public class MyMojo
extends AbstractMojo
{
/**
* @parameter expression="${plugin.artifacts}"
* @required
*/
private List pluginArtifacts;
public void execute()
throws MojoExecutionException
{
...
for ( Iterator i = pluginArtifacts.iterator(); i.hasNext(); )
{
Artifact pluginArtifact = (Artifact) i.next();
}
...
}
}
{code}
h2. I am h2
this is the way of the world
{noformat}
public class MyMojo
extends AbstractMojo
{
/**
* @parameter expression="${plugin.artifacts}"
* @required
*/
private List pluginArtifacts;
public void execute()
throws MojoExecutionException
{
...
for ( Iterator i = pluginArtifacts.iterator(); i.hasNext(); )
{
Artifact pluginArtifact = (Artifact) i.next();
}
...
}
}
{noformat}
h3. I am h3
this is the way of the world
h4. I am h4
this is the way of the world
h5. I am h5
this is the way of the world
h1. Answered Questions
h3. What can I do to get the Maven love?
Well, you just have to be calm and the maven love will come your way.
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/escapes.confluence 0000644 0001750 0001750 00000000262 10711134027 031301 0 ustar twerner twerner Simple paragraph with asterisk \* and underline \_.
Simple paragraph with asterisk \*not bold\* and underline \_not italic\_.
Simple paragraph with normal \character escaped.
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/simple-paragraph.confluence 0000644 0001750 0001750 00000000277 10711100347 033116 0 ustar twerner twerner Simple paragraph with *bold* and _italic_ text.
Here is a link to [JIRA|http://jira.codehaus.org]
Here is a link with no text [http://jira.codehaus.org]
This is some {{monospaced}} text.
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/section.confluence 0000644 0001750 0001750 00000000137 10710355722 031331 0 ustar twerner twerner h1. Section1
h2. Section2
h3. Section3
h4. Section4
h5. Section5
h1. TitleWithLeadingSpace
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/note-tip-info.confluence 0000644 0001750 0001750 00000000627 10721245572 032364 0 ustar twerner twerner Simple paragraph.
{note:title=Be Careful}
The body of the note here..
{note}
Tip
{tip:title=Guess What?}
The body of the tip here..
{tip}
Info
{info:title=Some
Info}
The body of the info here..
{info}
Quote
{quote:title=Simon Says}
The body of the *quote* here..
{quote}
(In all cases there is no way to reverse the Doxia output
back to confluence because they are all rendered as a defitionList.) doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/resources/paragraph-header.confluence 0000644 0001750 0001750 00000000073 10713410027 033050 0 ustar twerner twerner
A paragraph
h2. A header
with a header
Another paragraph
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/ 0000755 0001750 0001750 00000000000 11632765557 024547 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765557 025336 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 026557 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 027665 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 030771 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 032256 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/conflu0000755 0001750 0001750 00000000000 11632765557 033465 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkTest.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000015171 11207472163 033456 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractSinkTest;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.HtmlTools;
/**
* Test the Confluence Sink
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: ConfluenceSinkTest.java 779565 2009-05-28 11:24:35Z vsiveton $
* @see ConfluenceSink
*/
public class ConfluenceSinkTest
extends AbstractSinkTest
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new ConfluenceSink( writer );
}
/** {@inheritDoc} */
protected String getAnchorBlock( String anchor )
{
return ConfluenceMarkup.ANCHOR_START_MARKUP + anchor + ConfluenceMarkup.ANCHOR_END_MARKUP + anchor;
}
/** {@inheritDoc} */
protected boolean isXmlSink()
{
return false;
}
/** Not used.
* {@inheritDoc} */
protected String getAuthorBlock( String author )
{
return null;
}
/** Not used.
* {@inheritDoc} */
protected String getBodyBlock()
{
return null;
}
/** {@inheritDoc} */
protected String getBoldBlock( String text )
{
return ConfluenceMarkup.BOLD_START_MARKUP + text + ConfluenceMarkup.BOLD_END_MARKUP;
}
/** Not used.
* {@inheritDoc} */
protected String getDateBlock( String date )
{
return null;
}
/** Not used.
* {@inheritDoc} */
protected String getDefinitionListBlock( String definum, String definition )
{
return null;
}
/** {@inheritDoc} */
protected String getFigureBlock( String source, String caption )
{
return EOL + ConfluenceMarkup.FIGURE_START_MARKUP + source + ConfluenceMarkup.FIGURE_END_MARKUP + caption;
}
/** Not used.
* {@inheritDoc} */
protected String getHeadBlock()
{
return null;
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getItalicBlock( String text )
{
return ConfluenceMarkup.ITALIC_START_MARKUP + text + ConfluenceMarkup.ITALIC_END_MARKUP;
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return ConfluenceMarkup.LINE_BREAK_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getLinkBlock( String link, String text )
{
return ConfluenceMarkup.LINK_START_MARKUP + text + ConfluenceMarkup.LINK_MIDDLE_MARKUP + link
+ ConfluenceMarkup.LINK_END_MARKUP;
}
/** {@inheritDoc} */
protected String getListBlock( String item )
{
return ConfluenceMarkup.LIST_ITEM_MARKUP + item + EOL;
}
/** {@inheritDoc} */
protected String getMonospacedBlock( String text )
{
return ConfluenceMarkup.MONOSPACED_START_MARKUP + text + ConfluenceMarkup.MONOSPACED_END_MARKUP;
}
/** {@inheritDoc} */
protected String getNonBreakingSpaceBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getNumberedListBlock( String item )
{
return ConfluenceMarkup.NUMBERING_MARKUP + " " + item + EOL;
}
/** {@inheritDoc} */
protected String getPageBreakBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getParagraphBlock( String text )
{
return text + EOL + EOL;
}
/** {@inheritDoc} */
protected String getRawTextBlock( String text )
{
return "";
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return "h1. " + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return "h2. " + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection3Block( String title )
{
return "h3. " + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection4Block( String title )
{
return "h4. " + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection5Block( String title )
{
return "h5. " + title + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSectionTitleBlock( String title )
{
return title;
}
/** {@inheritDoc} */
protected String getTableBlock( String cell, String caption )
{
return "| " + cell + " |" + EOL + "Table_caption" + EOL + EOL;
}
/** {@inheritDoc} */
protected String getTextBlock( String text )
{
return HtmlTools.escapeHTML( text );
}
/** Not used.
* {@inheritDoc} */
protected String getTitleBlock( String title )
{
return null;
}
/** {@inheritDoc} */
protected String getVerbatimBlock( String text )
{
return "{code|borderStyle=solid}" + EOL + text + "{code}" + EOL + EOL;
}
/** {@inheritDoc} */
protected String outputExtension()
{
return "twiki";
}
// ----------------------------------------------------------------------
// Override unused tests
// ----------------------------------------------------------------------
/** Not used.
* {@inheritDoc} */
public void testAuthor()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testDate()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testHead()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testBody()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testTitle()
{
// nop
}
/** Not used.
* {@inheritDoc} */
public void testDefinitionList()
{
// nop
}
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
return "";
}
}
././@LongLink 0000000 0000000 0000000 00000000203 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/confluence/ConfluenceParserTest.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/test/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000050630 11375706236 033464 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.FilterWriter;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import org.apache.maven.doxia.parser.AbstractParserTest;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.TextSink;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
/**
* Test class for ConfluenceParser.
*/
public class ConfluenceParserTest
extends AbstractParserTest
{
private ConfluenceParser parser;
private StringWriter output;
private Reader reader;
private Writer writer;
/** {@inheritDoc} */
protected void setUp()
throws Exception
{
super.setUp();
parser = (ConfluenceParser) lookup( Parser.ROLE, "confluence" );
output = null;
reader = null;
writer = null;
}
/** {@inheritDoc} */
protected void tearDown()
throws Exception
{
IOUtil.close( output );
IOUtil.close( reader );
IOUtil.close( writer );
super.tearDown();
}
/** {@inheritDoc} */
protected Parser createParser()
{
return parser;
}
/** {@inheritDoc} */
protected String outputExtension()
{
return "confluence";
}
/** @throws Exception */
public void testMarkupTestPage()
throws Exception
{
String result = locateAndParseTestSourceFile( "test" );
assertContainsLines( result, "end:body" );
}
/** @throws Exception */
public void testParagraphWithSimpleFormatting()
throws Exception
{
String result = locateAndParseTestSourceFile( "simple-paragraph" );
assertContainsLines( result, "begin:bold\ntext: bold\n" );
assertContainsLines( result, "begin:italic\ntext: italic\n" );
assertContainsLines( result, "begin:monospaced\ntext: monospaced\n" );
assertContainsLines( result, "begin:link, name: http://jira.codehaus.org\ntext: http://jira.codehaus.org" );
assertContainsLines( result, "begin:link, name: http://jira.codehaus.org\ntext: JIRA\n" );
// four paragraphs in the input...
assertEquals( 5, result.split( "end:paragraph" ).length );
}
/** @throws Exception */
public void testLineBreak()
throws Exception
{
String lineBreak = getLineBreakString();
String result = locateAndParseTestSourceFile( "linebreak" );
assertContainsLines( result, "Line\n" + lineBreak );
assertContainsLines( result, "with 2\n" + lineBreak );
assertContainsLines( result, "inline\n" + lineBreak );
}
/** @throws Exception */
public void testEscapes()
throws Exception
{
String result = locateAndParseTestSourceFile( "escapes" );
assertContainsLines( result, "asterisk *" );
assertContainsLines( result, "underline _" );
assertContainsLines( result, "asterisk *not bold*" );
assertContainsLines( result, "underline _not italic_" );
assertContainsLines( result, "normal character" );
}
/** @throws Exception */
public void testSectionTitles()
throws Exception
{
String result = locateAndParseTestSourceFile( "section" );
for ( int i = 1; i <= 5; i++ )
{
assertContainsLines( "Could not locate section " + i + " title", result,
"sectionTitle" + i + "\ntext: Section" + i );
}
assertContainsLines( "Section title has leading space", result, "sectionTitle1\ntext: TitleWithLeadingSpace" );
}
/** @throws Exception */
public void testNestedBulletList()
throws Exception
{
String result = locateAndParseTestSourceFile( "nested-list" );
assertContainsLines( "Nested list not found", result,
"begin:listItem\ntext: A top level list item\nbegin:list" );
// two lists in the input...
assertEquals( 3, result.split( "end:list\n" ).length );
// ...and 4 list items
assertEquals( 5, result.split( "end:listItem\n" ).length );
}
/** @throws Exception */
public void testNestedHeterogenousList()
throws Exception
{
String result = locateAndParseTestSourceFile( "nested-list-heterogenous" );
// test heterogenous list
assertContainsLines( "Nested list not found", result, "begin:listItem\ntext: A top level list item\nbegin:numberedList" );
// exactly one list and one numberedList
assertEquals( 2, result.split( "begin:list\n" ).length );
assertEquals( 2, result.split( "begin:numberedList" ).length );
// ...and 4 list items
assertEquals( 5, result.split( "end:listItem\n" ).length );
}
/** @throws Exception */
public void testListWithSimpleFormatting()
throws Exception
{
String result = locateAndParseTestSourceFile( "simple-list" );
assertContainsLines( result, "begin:bold\ntext: bold\n" );
assertContainsLines( result, "begin:italic\ntext: italic\n" );
assertContainsLines( result, "begin:monospaced\ntext: monospaced\n" );
assertContainsLines( result, "begin:link, name: http://jira.codehaus.org\ntext: http://jira.codehaus.org\n" );
assertContainsLines( result, "begin:link, name: http://jira.codehaus.org\ntext: JIRA\n" );
assertContainsLines( result, "begin:listItem\ntext: Item with no formatting\nend:listItem\n" );
assertContainsLines( result, "begin:listItem\ntext: One bullet\nend:listItem\n" );
assertContainsLines( result, "begin:listItem\ntext: A list item with more than one line\nend:listItem\n" );
// 3 lists in the input...
assertEquals( 4, result.split( "end:list\n" ).length );
// ...and 7 list items
assertEquals( 8, result.split( "end:listItem\n" ).length );
}
/** @throws Exception */
public void testAnchor()
throws Exception
{
String result = locateAndParseTestSourceFile( "anchor" );
assertContainsLines( result, "begin:paragraph\nbegin:anchor, name: start\nend:anchor" );
assertContainsLines( result, "begin:anchor, name: middle\nend:anchor" );
assertContainsLines( result, "begin:paragraph\ntext: Simple paragraph\nbegin:anchor, name: end\nend:anchor" );
// 3 anchors in the input...
assertEquals( 4, result.split( "end:anchor\n" ).length );
}
/** @throws Exception */
public void testUnknownMacro()
throws Exception
{
String result = locateAndParseTestSourceFile( "unknown-macro" );
assertContainsLines( result, "begin:paragraph\ntext: {unknown:start}" );
}
/** @throws Exception */
public void testCodeMacro()
throws Exception
{
String result = locateAndParseTestSourceFile( "code" );
assertContainsLines( result, "begin:verbatim, boxed: true\ntext: public class Cat {" );
// 5 paragraphs in the input...
assertEquals( 5, result.split( "end:paragraph\n" ).length );
// 3 verbatim in the input...
assertEquals( 3, result.split( "end:verbatim\n" ).length );
}
/** @throws Exception */
public void testFigure()
throws Exception
{
String result = locateAndParseTestSourceFile( "figure" );
assertContainsLines( result, "begin:figure\nfigureGraphics, name: images/photo.jpg\nend:figure\n" );
assertContainsLines( result, "attempted inline !image.jpg! (should fail)" );
// this isn't ideal... Doxia captions are not the same as what people would use to add text to a confluence
assertContainsLines( result, "figureGraphics, name: images/photo.jpg\n"
+ "begin:figureCaption\ntext: With caption on same line\n" + "end:figureCaption" );
assertContainsLines( result, "figureGraphics, name: images/nolinebreak.jpg\n"
+ "begin:figureCaption\ntext: With caption underneath and no linebreak\nend:figureCaption" );
// ignore linebreak after figure insert...
assertContainsLines( result, "figureGraphics, name: images/linebreak.jpg\n"
+ "begin:figureCaption\ntext: With caption underneath and linebreak\nend:figureCaption" );
// ignore formtting in caption...
assertContainsLines( result, "figureGraphics, name: images/bold.jpg\n"
+ "begin:figureCaption\ntext: With *bold* caption underneath\nend:figureCaption" );
// DOXIA-303: image attributes are ignored
assertContainsLines( result, "begin:figure\nfigureGraphics, name: image.gif\nend:figure\n" );
// 2 paragraphs in the input... (the figures do not go in a paragraph by analogy with AptParser)
assertEquals( 3, result.split( "end:paragraph\n" ).length );
}
/** @throws Exception */
public void testLink()
throws Exception
{
String result = locateAndParseTestSourceFile( "link" );
assertContainsLines( result, "begin:link, name: middle.html\ntext: middle\nend:link" );
assertContainsLines( result, "begin:link, name: end.html\ntext: end\nend:link" );
assertContainsLines( result, "begin:link, name: link.html\ntext: alias\nend:link" );
assertContainsLines( result, "begin:link, name: link.html#anchor\ntext: link#anchor\nend:link" );
assertContainsLines( result, "begin:link, name: #simple\ntext: simple\nend:link" );
// 3 paragraphs in the input...
assertEquals( 4, result.split( "end:paragraph\n" ).length );
// 5 links in the input...
assertEquals( 6, result.split( "end:link\n" ).length );
}
/** @throws Exception */
public void testTableWithLinks()
throws Exception
{
String result = locateAndParseTestSourceFile( "table-link" );
assertContainsLines( result, "begin:tableCell\nbegin:link, name: http://example.com/release.0.1.3/ex-win32-win32.x86.zip\ntext: Download\nend:link\n\n\nend:tableCell\n" );
assertContainsLines( result, "begin:tableCell\nbegin:link, name: http://example.com/release.0.1.2/ex-win32-win32.x86.zip\ntext: http://example.com/release.0.1.2/ex-win32-win32.x86.zip\nend:link\n\n\nend:tableCell\n" );
// 3 links in the input
assertEquals( 4, result.split( "end:link\n" ).length );
}
/** @throws Exception */
public void testParagraphWithList()
throws Exception
{
String result = locateAndParseTestSourceFile( "paragraph-list" );
assertContainsLines( result, "begin:paragraph\ntext: A paragraph\nend:paragraph\n" );
assertContainsLines( result, "begin:listItem\ntext: A nested list item\nend:listItem\n" );
assertContainsLines( result, "begin:listItem\ntext: Another nested list item with two lines\nend:listItem\n" );
// 2 paragraphs in the input...
assertEquals( 3, result.split( "end:paragraph\n" ).length );
// 1 list in the input...
assertEquals( 2, result.split( "end:list\n" ).length );
}
/** @throws Exception */
public void testParagraphWithFigure()
throws Exception
{
String result = locateAndParseTestSourceFile( "paragraph-figure" );
assertContainsLines( result, "begin:paragraph\ntext: A paragraph\nend:paragraph\n" );
assertContainsLines( result, "begin:figure\nfigureGraphics, name: images/logo.png\nbegin:figureCaption\ntext: with a figure\nend:figureCaption" );
// 2 paragraphs in the input...
assertEquals( 3, result.split( "end:paragraph\n" ).length );
// 1 figure in the input...
assertEquals( 2, result.split( "end:figure\n" ).length );
}
/** @throws Exception */
public void testParagraphWithHeader()
throws Exception
{
String result = locateAndParseTestSourceFile( "paragraph-header" );
assertContainsLines( result, "begin:paragraph\ntext: A paragraph\nend:paragraph\n" );
assertContainsLines( result, "begin:section2\nbegin:sectionTitle2\ntext: A header\nend:sectionTitle2" );
// 3 paragraphs in the input...
assertEquals( 4, result.split( "end:paragraph\n" ).length );
// 1 header in the input...
assertEquals( 2, result.split( "end:sectionTitle2\n" ).length );
}
/** @throws Exception */
public void testNestedFormats()
throws Exception
{
String result = locateAndParseTestSourceFile( "nested-format" );
assertContainsLines( result, "begin:bold\nbegin:italic\ntext: bold italic\nend:italic" );
assertContainsLines( result, "begin:italic\nbegin:bold\ntext: italic bold\nend:bold" );
assertContainsLines( result, "begin:bold\nbegin:monospaced\ntext: bold monospaced\nend:monospaced" );
assertContainsLines( result, "text: A paragraph with \nbegin:bold\ntext: bold \nbegin:italic\ntext: italic\nend:italic" );
assertContainsLines( result, "begin:italic\ntext: italic \nbegin:bold\ntext: bold\nend:bold" );
assertContainsLines( result, "begin:bold\ntext: bold \nbegin:monospaced\ntext: monospaced\nend:monospaced" );
// 2 paragraphs in the input...
assertEquals( 3, result.split( "end:paragraph\n" ).length );
// 6 bolds in the input...
assertEquals( 7, result.split( "end:bold\n" ).length );
// 4 italics in the input...
assertEquals( 5, result.split( "end:italic\n" ).length );
// 2 monospaced in the input...
assertEquals( 3, result.split( "end:monospaced\n" ).length );
}
/** @throws Exception */
public void testNoteInfoTipQuote()
throws Exception
{
String result = locateAndParseTestSourceFile( "note-tip-info" );
assertContainsLines( result, "begin:definedTerm\ntext: Be Careful\nend:definedTerm\n" );
assertContainsLines( result, "begin:definition\ntext: The body of the note here..\nend:definition" );
assertContainsLines( result, "begin:definedTerm\ntext: Guess What?\nend:definedTerm\n" );
assertContainsLines( result, "begin:definition\ntext: The body of the tip here..\nend:definition" );
assertContainsLines( result, "begin:definedTerm\ntext: Some Info\nend:definedTerm\n" );
assertContainsLines( result, "begin:definition\ntext: The body of the info here..\nend:definition" );
assertContainsLines( result, "begin:definedTerm\ntext: Simon Says\nend:definedTerm\n" );
assertContainsLines( result, "begin:definition\ntext: The body of the \nbegin:bold\ntext: quote\nend:bold" );
// 5 paragraphs in the input...
assertEquals( 6, result.split( "end:paragraph\n" ).length );
// 4 dinitionList in the input...
assertEquals( 5, result.split( "end:definitionList\n" ).length );
}
/**
* DOXIA-247
*
* @throws ParseException if something goes wrong.
*/
public void testEndBracket()
throws ParseException
{
String document = "Test"
+ "\n\n* list1"
+ "\n\n* list2"
+ "\n\n* list2"
+ "\n{pre}123{/pre}";
output = new StringWriter();
Sink sink = new TextSink( output );
/* parsing with additional space at end works */
createParser().parse( new StringReader( document + " " ), sink );
assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );
/* parsing with document ending in } should not fail */
try
{
createParser().parse( new StringReader( document ), sink );
}
catch ( Exception e )
{
e.printStackTrace();
fail( "parsing with document ending in } should not fail" );
}
assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );
}
/**
* DOXIA-247
*
* @throws ParseException
*/
public void testEndBracketInList()
throws ParseException
{
String document1 = "Test"
+ "\n\n* list1"
+ "\n\n* list2"
+ "\n\n* list2{pre}123{/pre} "
+ "\n123";
String document2 = "Test"
+ "\n\n* list1"
+ "\n\n* list2"
+ "\n\n* list2{pre}123{/pre}"
+ "\n123";
output = new StringWriter();
Sink sink = new TextSink( output );
/* parsing with additional space at end of list item works */
createParser().parse( new StringReader( document1 ), sink );
assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );
/* parsing with end of list item ending in } should not fail */
try
{
createParser().parse( new StringReader( document2 ), sink );
}
catch ( Exception e )
{
e.printStackTrace();
fail( "parsing with end of list item ending in } should not fail" );
}
assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );
}
public void testDoxia382SinkCannotBeReused()
throws ParseException
{
String document1 = "Test A"
+ "\n\n* list1"
+ "\n\n* list2"
+ "\n\n* list2{pre}123{/pre} "
+ "\n123";
String document2 = "Test B"
+ "\n\n* list1"
+ "\n\n* list2"
+ "\n\n* list2{pre}123{/pre}"
+ "\n123";
output = new StringWriter();
Sink sink = new TextSink( new FilterWriter( output )
{
public void close() throws IOException
{
super.close();
this.out = null;
}
public void write( String str, int off, int len )
throws IOException
{
if ( out == null )
{
throw new IOException( "Writing to an already closed Writer" );
}
}
});
createParser().parse( new StringReader( document1 ), sink );
createParser().parse( new StringReader( document2 ), sink );
}
/**
* DOXIA-370
*
* @throws ParseException
*/
public void testSeparatorInParagraph()
throws ParseException
{
String document = "Up\n---\nDown\n";
output = new StringWriter();
Sink sink = new TextSink( output );
/* parsing with separator in middle of paragraph */
createParser().parse( new StringReader( document ), sink );
assertTrue( "generated document should have a size > 0", output.toString().length() > 0 );
}
private void assertContainsLines( String message, String result, String lines )
{
lines = StringUtils.replace( lines, "\n", EOL );
if ( message != null )
{
assertTrue( message, result.indexOf( lines ) != -1 );
}
else
{
assertTrue( result.indexOf( lines ) != -1 );
}
}
private void assertContainsLines( String result, String lines )
{
this.assertContainsLines( null, result, lines );
}
private String getLineBreakString()
{
StringWriter sw = new StringWriter();
Sink sink = new TextSink( sw );
sink.lineBreak();
return sw.toString();
}
private String locateAndParseTestSourceFile( String stem )
throws IOException, ParseException
{
output = new StringWriter();
reader = getTestReader( stem, outputExtension() );
writer = getTestWriter( stem, "txt" );
Sink sink = new TextSink( output );
createParser().parse( reader, sink );
// write to file
String expected = output.toString();
writer.write( expected );
writer.flush();
return expected;
}
}
doxia-1.1.4/doxia-modules/doxia-module-confluence/src/site/ 0000755 0001750 0001750 00000000000 11632765557 023613 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 025257 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
-->
<project>
<body>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project> doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/ 0000755 0001750 0001750 00000000000 11632765557 023573 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/ 0000755 0001750 0001750 00000000000 11632765557 024514 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765557 025303 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 026524 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 027632 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 030736 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 032223 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000755 0001750 0001750 00000000000 11632765557 033432 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000175 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSink.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000046504 11244500657 033430 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Stack;
import javax.swing.text.html.HTML.Attribute;
import org.apache.maven.doxia.sink.AbstractTextSink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
/**
* Confluence Sink implementation.
* <br/>
* <b>Note</b>: The encoding used is UTF-8.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: ConfluenceSink.java 807167 2009-08-24 12:03:59Z vsiveton $
* @since 1.0
*/
public class ConfluenceSink
extends AbstractTextSink
implements ConfluenceMarkup
{
/** The writer to use. */
private final PrintWriter out;
/** The writer to use. */
private StringWriter writer;
/** An indication on if we're in head mode. */
private boolean headFlag;
private int levelList = 0;
/** listStyles. */
private final Stack listStyles;
/** An indication on if we're in verbatim box mode. */
private boolean verbatimBoxedFlag;
/** An indication on if we're in table header mode. */
private boolean tableHeaderFlag;
/** The link name. */
private String linkName;
/**
* Constructor, initialize the Writer and the variables.
*
* @param writer not null writer to write the result. <b>Should</b> be an UTF-8 Writer.
* You could use <code>newWriter</code> methods from {@link org.codehaus.plexus.util.WriterFactory}.
*/
protected ConfluenceSink( Writer writer )
{
this.out = new PrintWriter( writer );
this.listStyles = new Stack();
init();
}
/** {@inheritDoc} */
public void anchor( String name )
{
write( ANCHOR_START_MARKUP + name + ANCHOR_END_MARKUP );
}
/** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
anchor( name );
}
/**
* Not used.
* {@inheritDoc}
*/
public void anchor_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void author()
{
// nop
}
/** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
author();
}
/**
* Not used.
* {@inheritDoc}
*/
public void author_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void body()
{
// nop
}
/** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
body();
}
/**
* Not used.
* {@inheritDoc}
*/
public void body_()
{
// nop
}
/** {@inheritDoc} */
public void bold()
{
write( BOLD_START_MARKUP );
}
/** {@inheritDoc} */
public void bold_()
{
write( BOLD_END_MARKUP );
}
/**
* Not used.
* {@inheritDoc}
*/
public void comment( String comment )
{
// nop
}
/** {@inheritDoc} */
public void close()
{
out.write( writer.toString() );
out.close();
init();
}
/**
* Not used.
* {@inheritDoc}
*/
public void date()
{
// nop
}
/** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
date();
}
/**
* Not used.
* {@inheritDoc}
*/
public void date_()
{
// nop
}
/** {@inheritDoc} */
public void definedTerm()
{
write( " " );
}
/** {@inheritDoc} */
public void definedTerm( SinkEventAttributes attributes )
{
definedTerm();
}
/**
* Not used.
* {@inheritDoc}
*/
public void definedTerm_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definition()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definition( SinkEventAttributes attributes )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definition_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionList()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionList( SinkEventAttributes attributes )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionList_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionListItem()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionListItem( SinkEventAttributes attributes )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void definitionListItem_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void figure()
{
// nop
}
/** {@inheritDoc} */
public void figure( SinkEventAttributes attributes )
{
figure();
}
/**
* Not used.
* {@inheritDoc}
*/
public void figure_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void figureCaption()
{
// nop
}
/** {@inheritDoc} */
public void figureCaption( SinkEventAttributes attributes )
{
figureCaption();
}
/**
* Not used.
* {@inheritDoc}
*/
public void figureCaption_()
{
// nop;
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
writeEOL();
write( FIGURE_START_MARKUP + name + FIGURE_END_MARKUP );
}
/** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
figureGraphics( src );
if ( attributes != null && attributes.getAttribute( Attribute.ALT.toString() ) != null )
{
write( attributes.getAttribute( Attribute.ALT.toString() ).toString() );
writeEOL( true );
}
}
/** {@inheritDoc} */
public void flush()
{
close();
writer.flush();
}
/** {@inheritDoc} */
public void head()
{
init();
headFlag = true;
}
/** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
head();
}
/** {@inheritDoc} */
public void head_()
{
headFlag = false;
}
/**
* Not used.
* {@inheritDoc}
*/
public void horizontalRule()
{
// nop
}
/** {@inheritDoc} */
public void horizontalRule( SinkEventAttributes attributes )
{
horizontalRule();
}
/** {@inheritDoc} */
public void italic()
{
write( ITALIC_START_MARKUP );
}
/** {@inheritDoc} */
public void italic_()
{
write( ITALIC_END_MARKUP );
}
/** {@inheritDoc} */
public void lineBreak()
{
write( LINE_BREAK_MARKUP );
writeEOL();
}
/** {@inheritDoc} */
public void lineBreak( SinkEventAttributes attributes )
{
lineBreak();
}
/** {@inheritDoc} */
public void link( String name )
{
linkName = name;
}
/** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
link( name );
}
/** {@inheritDoc} */
public void link_()
{
linkName = null;
write( LINK_END_MARKUP );
}
/** {@inheritDoc} */
public void list()
{
if ( !writer.toString().endsWith( EOL + EOL ) )
{
writeEOL( true );
}
levelList++;
}
/** {@inheritDoc} */
public void list( SinkEventAttributes attributes )
{
list();
}
/** {@inheritDoc} */
public void list_()
{
levelList--;
}
/** {@inheritDoc} */
public void listItem()
{
write( StringUtils.repeat( "*", levelList ) + " " );
}
/** {@inheritDoc} */
public void listItem( SinkEventAttributes attributes )
{
listItem();
}
/** {@inheritDoc} */
public void listItem_()
{
writeEOL( true );
}
/** {@inheritDoc} */
public void monospaced()
{
write( MONOSPACED_START_MARKUP );
}
/** {@inheritDoc} */
public void monospaced_()
{
write( MONOSPACED_END_MARKUP );
}
/**
* Not used.
* {@inheritDoc}
*/
public void nonBreakingSpace()
{
// nop
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
levelList++;
String style;
switch ( numbering )
{
case NUMBERING_UPPER_ALPHA:
case NUMBERING_LOWER_ALPHA:
case NUMBERING_UPPER_ROMAN:
case NUMBERING_LOWER_ROMAN:
case NUMBERING_DECIMAL:
default:
style = NUMBERING_MARKUP;
}
listStyles.push( style );
}
/** {@inheritDoc} */
public void numberedList( int numbering, SinkEventAttributes attributes )
{
numberedList( numbering );
}
/** {@inheritDoc} */
public void numberedList_()
{
levelList--;
listStyles.pop();
}
/** {@inheritDoc} */
public void numberedListItem()
{
writeEOL( true );
String style = (String) listStyles.peek();
write( style + SPACE );
}
/** {@inheritDoc} */
public void numberedListItem( SinkEventAttributes attributes )
{
numberedListItem();
}
/** {@inheritDoc} */
public void numberedListItem_()
{
writeEOL( true );
}
/**
* Not used.
* {@inheritDoc}
*/
public void pageBreak()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void paragraph()
{
// nop
}
/** {@inheritDoc} */
public void paragraph( SinkEventAttributes attributes )
{
paragraph();
}
/** {@inheritDoc} */
public void paragraph_()
{
writeEOL( true );
writeEOL();
}
/**
* Not used.
* {@inheritDoc}
*/
public void rawText( String text )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section( int level, SinkEventAttributes attributes )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section1()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section1_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section2()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section2_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section3()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section3_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section4()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section4_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section5()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section5_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void section_( int level )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void sectionTitle()
{
// nop
}
/** {@inheritDoc} */
public void sectionTitle( int level, SinkEventAttributes attributes )
{
if ( level > 0 && level < 6 )
{
write( "h" + level + ". " );
}
}
/** {@inheritDoc} */
public void sectionTitle1()
{
sectionTitle( 1, null );
}
/** {@inheritDoc} */
public void sectionTitle1_()
{
sectionTitle_( 1 );
}
/** {@inheritDoc} */
public void sectionTitle2()
{
sectionTitle( 2, null );
}
/** {@inheritDoc} */
public void sectionTitle2_()
{
sectionTitle_( 2 );
}
/** {@inheritDoc} */
public void sectionTitle3()
{
sectionTitle( 3, null );
}
/** {@inheritDoc} */
public void sectionTitle3_()
{
sectionTitle_( 3 );
}
/** {@inheritDoc} */
public void sectionTitle4()
{
sectionTitle( 4, null );
}
/** {@inheritDoc} */
public void sectionTitle4_()
{
sectionTitle_( 4 );
}
/** {@inheritDoc} */
public void sectionTitle5()
{
sectionTitle( 5, null );
}
/** {@inheritDoc} */
public void sectionTitle5_()
{
sectionTitle_( 5 );
}
/**
* Not used.
* {@inheritDoc}
*/
public void sectionTitle_()
{
// nop
}
/** {@inheritDoc} */
public void sectionTitle_( int level )
{
writeEOL( true );
writeEOL();
}
/** {@inheritDoc} */
public void table()
{
// nop
writeEOL( true );
writeEOL();
}
/** {@inheritDoc} */
public void table( SinkEventAttributes attributes )
{
table();
}
/** {@inheritDoc} */
public void table_()
{
writeEOL( true );
writeEOL();
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableCaption()
{
// nop
}
/** {@inheritDoc} */
public void tableCaption( SinkEventAttributes attributes )
{
tableCaption();
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableCaption_()
{
// nop
}
/** {@inheritDoc} */
public void tableCell()
{
write( " " );
}
/** {@inheritDoc} */
public void tableCell( SinkEventAttributes attributes )
{
tableCell();
}
/** {@inheritDoc} */
public void tableCell( String width )
{
tableCell();
}
/** {@inheritDoc} */
public void tableCell_()
{
write( " " );
write( TABLE_CELL_MARKUP );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
tableHeaderFlag = true;
write( TABLE_CELL_HEADER_START_MARKUP );
}
/** {@inheritDoc} */
public void tableHeaderCell( SinkEventAttributes attributes )
{
tableHeaderCell();
}
/** {@inheritDoc} */
public void tableHeaderCell( String width )
{
tableHeaderCell();
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
write( TABLE_CELL_HEADER_END_MARKUP );
}
/** {@inheritDoc} */
public void tableRow()
{
write( TABLE_ROW_MARKUP );
}
/** {@inheritDoc} */
public void tableRow( SinkEventAttributes attributes )
{
tableRow();
}
/** {@inheritDoc} */
public void tableRow_()
{
if ( tableHeaderFlag )
{
tableHeaderFlag = false;
write( TABLE_ROW_MARKUP );
}
writeEOL( true );
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableRows( int[] justification, boolean grid )
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void tableRows_()
{
// nop
}
/** {@inheritDoc} */
public void text( String text )
{
if ( headFlag )
{
return;
}
if ( linkName != null )
{
write( LINK_START_MARKUP );
}
content( text );
if ( linkName != null )
{
write( LINK_MIDDLE_MARKUP + linkName );
}
}
/** {@inheritDoc} */
public void text( String text, SinkEventAttributes attributes )
{
text( text );
}
/**
* Not used.
* {@inheritDoc}
*/
public void title()
{
// nop
}
/** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
title();
}
/**
* Not used.
* {@inheritDoc}
*/
public void title_()
{
// nop
}
/**
* Not used.
* {@inheritDoc}
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
// nop
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
if ( boxed )
{
verbatimBoxedFlag = true;
}
if ( verbatimBoxedFlag )
{
write( "{code|borderStyle=solid}" );
}
else
{
write( "{noformat}" );
}
writeEOL( true );
}
/** {@inheritDoc} */
public void verbatim_()
{
if ( verbatimBoxedFlag )
{
write( "{code}" );
}
else
{
write( "{noformat}" );
}
writeEOL( true );
writeEOL();
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
private void write( String text )
{
writer.write( unifyEOLs( text ) );
}
/**
* Writes a system EOL.
*/
private void writeEOL()
{
write( EOL );
}
/**
* Writes a system EOL, with or without trim.
*/
private void writeEOL( boolean trim )
{
if ( !trim )
{
writeEOL();
return;
}
String tmp = writer.toString().trim();
writer = new StringWriter();
writer.write( tmp );
write( EOL );
}
/**
* Write HTML escaped text to output.
*
* @param text The text to write.
*/
protected void content( String text )
{
write( escapeHTML( text ) );
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.writer = new StringWriter();
this.headFlag = false;
this.levelList = 0;
this.listStyles.clear();
this.verbatimBoxedFlag = false;
this.tableHeaderFlag = false;
this.linkName = null;
}
/**
* Forward to HtmlTools.escapeHTML( text ).
*
* @param text the String to escape, may be null
* @return the text escaped, "" if null String input
* @see org.apache.maven.doxia.util.HtmlTools#escapeHTML(String)
*/
protected static String escapeHTML( String text )
{
return HtmlTools.escapeHTML( text );
}
}
././@LongLink 0000000 0000000 0000000 00000000203 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSiteModule.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002645 11212745470 033425 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
* <p>ConfluenceSiteModule class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: ConfluenceSiteModule.java 782392 2009-06-07 14:14:16Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="confluence"
*/
public class ConfluenceSiteModule
extends AbstractSiteModule
{
/**
* Default constructor.
*/
public ConfluenceSiteModule()
{
super( "confluence", "confluence", "confluence" );
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceMarkup.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000006413 11077077137 033431 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.markup.TextMarkup;
/**
* This interface defines all markups and syntaxes used by the <b>Confluence</b> format.
*
* See <a href="http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview">
* Confluence Notation Guide Overview</a>
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: ConfluenceMarkup.java 706268 2008-10-20 12:49:35Z vsiveton $
* @since 1.0
*/
public interface ConfluenceMarkup
extends TextMarkup
{
// ----------------------------------------------------------------------
// Confluence markups
// ----------------------------------------------------------------------
/** Syntax for the anchor : "{anchor:" */
String ANCHOR_START_MARKUP = "{anchor:";
/** Syntax for the anchor : "}" */
String ANCHOR_END_MARKUP = "}";
/** Syntax for the bold markup: "*" */
String BOLD_END_MARKUP = "*";
/** Syntax for the bold markup: "*" */
String BOLD_START_MARKUP = "*";
/** Syntax for the figure markup: "!" */
String FIGURE_END_MARKUP = "!";
/** Syntax for the figure markup: "!" */
String FIGURE_START_MARKUP = "!";
/** Syntax for the italic markup: "_" */
String ITALIC_END_MARKUP = "_";
/** Syntax for the italic markup: "_" */
String ITALIC_START_MARKUP = "_";
/** Syntax for the line break markup: "\\\\" */
String LINE_BREAK_MARKUP = "\\\\";
/** Syntax for the link end markup: "]" */
String LINK_END_MARKUP = "]";
/** Syntax for the link middle markup: "|" */
String LINK_MIDDLE_MARKUP = "|";
/** Syntax for the link start markup: "[" */
String LINK_START_MARKUP = "[";
/** Syntax for the list item markup: "* */
String LIST_ITEM_MARKUP = "* ";
/** Syntax for the mono-spaced style end: "{{" */
String MONOSPACED_END_MARKUP = "{{";
/** Syntax for the mono-spaced style start: "}}" */
String MONOSPACED_START_MARKUP = "}}";
/** Syntax for the numbering decimal markup char: "1." */
String NUMBERING_MARKUP = "1.";
/** Syntax for the table cell header end markup: "|" */
String TABLE_CELL_HEADER_END_MARKUP = "|";
/** Syntax for the table cell header start markup: "|" */
String TABLE_CELL_HEADER_START_MARKUP = "|";
/** Syntax for the table cell markup: "|" */
String TABLE_CELL_MARKUP = "|";
/** Syntax for the table row markup: "|" */
String TABLE_ROW_MARKUP = "|";
}
././@LongLink 0000000 0000000 0000000 00000000204 00000000000 011561 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceSinkFactory.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003140 11105660512 033406 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractTextSinkFactory;
import org.apache.maven.doxia.sink.Sink;
/**
* Confluence implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: ConfluenceSinkFactory.java 712574 2008-11-09 22:16:42Z hboutemy $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="confluence"
*/
public class ConfluenceSinkFactory
extends AbstractTextSinkFactory
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding )
{
// encoding can safely be ignored since it isn't written into the generated Confluence source
return new ConfluenceSink( writer );
}
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000755 0001750 0001750 00000000000 11632765557 033432 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000167 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/ doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000755 0001750 0001750 00000000000 11632765557 033432 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000220 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellHeaderBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002677 10767707462 033447 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.table;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.confluence.parser.AbstractFatherBlock;
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: TableCellHeaderBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class TableCellHeaderBlock
extends AbstractFatherBlock
{
TableCellHeaderBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.tableHeaderCell();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.tableHeaderCell_();
}
}
././@LongLink 0000000 0000000 0000000 00000000214 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000012021 11203262772 033411 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.table;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import java.util.ArrayList;
import java.util.LinkedList;
import java.util.List;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.module.confluence.ConfluenceMarkup;
import org.apache.maven.doxia.module.confluence.parser.FigureBlockParser;
import org.apache.maven.doxia.module.confluence.parser.ParagraphBlockParser;
import org.apache.maven.doxia.module.confluence.parser.SectionBlockParser;
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.module.confluence.parser.BlockParser;
import org.apache.maven.doxia.module.confluence.parser.Block;
import org.apache.maven.doxia.module.confluence.parser.BoldBlock;
import org.apache.maven.doxia.parser.ParseException;
import org.codehaus.plexus.util.StringUtils;
/**
* Parse tables
*
* @author Juan F. Codagnone
* @version $Id: TableBlockParser.java 775115 2009-05-15 12:54:18Z ltheussl $
*/
public class TableBlockParser
implements BlockParser
{
private static final String EMPTY_STRING = "";
private static final String ANY_CHARACTER = ".*";
private static final String ESCAPE_CHARACTER = "\\";
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
return line.startsWith( "|" );
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
if ( !accept( line, source ) )
{
throw new IllegalAccessError( "call accept before this ;)" );
}
List rows = new ArrayList();
String l = line;
do
{
l = l.substring( 0, l.lastIndexOf( "|" ) );
List cells = new ArrayList();
BlockParser headingParser = new SectionBlockParser();
BlockParser figureParser = new FigureBlockParser();
BlockParser[] subparsers = new BlockParser[] { headingParser, figureParser };
BlockParser paragraphParser = new ParagraphBlockParser( subparsers );
if ( l.startsWith( "||" ) )
{
String[] text = StringUtils.split( l, "||" );
for ( int i = 0; i < text.length; i++ )
{
List textBlocks = new ArrayList();
textBlocks.add( ( ( ParagraphBlockParser) paragraphParser )
.visit(text[i], new ByLineReaderSource( new StringReader( EMPTY_STRING ) ), false ) );
List blocks = new ArrayList();
blocks.add( new BoldBlock( textBlocks ) );
cells.add( new TableCellHeaderBlock( blocks ) );
}
}
else
{
int it = 0;
String[] text = StringUtils.split( l, "|" );
List texts = new LinkedList();
while ( it < text.length )
{
if ( text[it].matches( ANY_CHARACTER + ESCAPE_CHARACTER
+ ConfluenceMarkup.LINK_START_MARKUP + ANY_CHARACTER )
&& !text[it].matches( ANY_CHARACTER + ESCAPE_CHARACTER
+ ConfluenceMarkup.LINK_END_MARKUP + ANY_CHARACTER ) )
{
texts.add( text[it] + ConfluenceMarkup.TABLE_CELL_MARKUP + text[it + 1] );
it += 2;
continue;
}
texts.add( text[it] );
it++;
}
Object[] pText = texts.toArray();
for ( int i = 0; i < pText.length; i++ )
{
List blocks = new ArrayList();
blocks.add( ( (ParagraphBlockParser) paragraphParser ).visit( (String) pText[i],
new ByLineReaderSource( new StringReader( EMPTY_STRING ) ), false ) );
cells.add( new TableCellBlock( blocks ) );
}
}
rows.add( new TableRowBlock( cells ) );
}
while ( ( l = source.getNextLine() ) != null && accept( l, source ) );
assert rows.size() >= 1;
return new TableBlock( rows );
}
}
././@LongLink 0000000 0000000 0000000 00000000206 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003502 11167436114 033417 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.table;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.confluence.parser.AbstractFatherBlock;
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: TableBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class TableBlock
extends AbstractFatherBlock
{
TableBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.table();
sink.tableRows( getJustification(), false );
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.tableRows_();
sink.table_();
}
private int[] getJustification()
{
final AbstractFatherBlock b = ( (AbstractFatherBlock) getBlocks().get( 0 ) );
int[] justification = new int[b.getBlocks().size()];
for ( int i = 0; i < justification.length; i++ )
{
justification[i] = Sink.JUSTIFY_CENTER;
}
return justification;
}
}
././@LongLink 0000000 0000000 0000000 00000000211 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableRowBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002634 10767707462 033440 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.table;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.confluence.parser.AbstractFatherBlock;
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: TableRowBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class TableRowBlock
extends AbstractFatherBlock
{
TableRowBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.tableRow();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.tableRow_();
}
}
././@LongLink 0000000 0000000 0000000 00000000212 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/table/TableCellBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002641 10767707462 033436 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.table;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.confluence.parser.AbstractFatherBlock;
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: TableCellBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class TableCellBlock
extends AbstractFatherBlock
{
TableCellBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.tableCell();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.tableCell_();
}
}
././@LongLink 0000000 0000000 0000000 00000000217 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000005371 11150513171 033414 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineSource;
/**
* <p>DefinitionListBlockParser class.</p>
*
* @author Dave Syer
* @version $Id: DefinitionListBlockParser.java 746983 2009-02-23 12:28:41Z vsiveton $
* @since 1.1
*/
public class DefinitionListBlockParser
implements BlockParser
{
static final String LS = System.getProperty( "line.separator" );
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
return ( line.startsWith( "{note" ) || line.startsWith( "{tip" )
|| line.startsWith( "{info" ) || line.startsWith( "{quote" ) );
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
StringBuffer text = new StringBuffer();
StringBuffer title = new StringBuffer();
int index = line.indexOf( "title=" );
if ( index >= 0 )
{
line = line.substring( index + 6 );
while ( !( line.indexOf( "}" ) >= 0 ) && line != null )
{
append( title, line );
line = source.getNextLine();
}
if ( line != null )
{
append( title, line.substring( 0, line.indexOf( "}" ) ) );
}
}
while ( ( line = source.getNextLine() ) != null )
{
if ( line.startsWith( "{note" ) || line.startsWith( "{tip" )
|| line.startsWith( "{info" ) || line.startsWith( "{quote" ) )
{
break;
}
append( text, line );
}
return new DefinitionListBlock( title.toString(), text.toString() );
}
private void append( StringBuffer title, String line )
{
if ( title.length() > 0 )
{
title.append( " " );
}
title.append( line.trim() );
}
}
././@LongLink 0000000 0000000 0000000 00000000204 00000000000 011561 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/MonospaceBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002515 10767707462 033436 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: MonospaceBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class MonospaceBlock extends AbstractFatherBlock
{
MonospaceBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.monospaced();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.monospaced_();
}
}
././@LongLink 0000000 0000000 0000000 00000000211 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002205 10767707462 033432 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @version $Id: HorizontalRuleBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class HorizontalRuleBlock
implements Block
{
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.horizontalRule();
}
}
././@LongLink 0000000 0000000 0000000 00000000211 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/DefinitionListBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003545 10767707462 033442 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Iterator;
import java.util.List;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
/**
* @version $Id: DefinitionListBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class DefinitionListBlock
implements Block
{
private String title;
private List text;
DefinitionListBlock( String title, String text )
{
this.title = title;
this.text = new ChildBlocksBuilder( text ).getBlocks();
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.definitionList();
if ( !StringUtils.isEmpty( title ) )
{
sink.definedTerm();
sink.text( title );
sink.definedTerm_();
}
sink.definition();
for ( Iterator iterator = text.iterator(); iterator.hasNext(); )
{
Block block = (Block) iterator.next();
block.traverse( sink );
}
sink.definition_();
sink.definitionList_();
}
}
././@LongLink 0000000 0000000 0000000 00000000211 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003777 11150513171 033424 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* <p>VerbatimBlockParser class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: VerbatimBlockParser.java 746983 2009-02-23 12:28:41Z vsiveton $
*/
public class VerbatimBlockParser
implements BlockParser
{
static final String LS = System.getProperty( "line.separator" );
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
if ( line.startsWith( "{code" ) || line.startsWith( "{noformat}" ) )
{
return true;
}
return false;
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
StringBuffer text = new StringBuffer();
while ( ( line = source.getNextLine() ) != null )
{
if ( line.startsWith( "{code}" ) || line.startsWith( "{noformat}" ) )
{
break;
}
// TODO
text.append( line ).append( LS );
}
return new VerbatimBlock( text.toString() );
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/TextBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002620 11167436114 033417 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* <p>TextBlock class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: TextBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class TextBlock
implements Block
{
private String text;
/**
* <p>Constructor for TextBlock.</p>
*
* @param text the text.
*/
public TextBlock( String text )
{
this.text = text;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.text( text );
}
}
././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003176 10767707462 033442 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @version $Id: FigureBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class FigureBlock
implements Block
{
private String location;
private String caption;
FigureBlock( String location )
{
this.location = location;
}
FigureBlock( String image, String caption )
{
this.location = image;
this.caption = caption;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.figure();
sink.figureGraphics( location );
if ( caption != null && caption.length() > 0 )
{
sink.figureCaption();
new TextBlock( caption ).traverse( sink );
sink.figureCaption_();
}
sink.figure_();
}
}
././@LongLink 0000000 0000000 0000000 00000000211 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AbstractFatherBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000004372 11216135717 033425 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Iterator;
import java.util.List;
import org.apache.maven.doxia.sink.Sink;
/**
* <p>Abstract AbstractFatherBlock class.</p>
*
* @version $Id: AbstractFatherBlock.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public abstract class AbstractFatherBlock
implements Block
{
private List blocks;
/**
* <p>before.</p>
*
* @param sink the Sink to receive events.
*/
public abstract void before( Sink sink );
/**
* <p>after.</p>
*
* @param sink the Sink to receive events.
*/
public abstract void after( Sink sink );
/**
* <p>Constructor for AbstractFatherBlock.</p>
*
* @param childBlocks the child blocks.
*/
public AbstractFatherBlock( List childBlocks )
{
if ( childBlocks == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.blocks = childBlocks;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
before( sink );
for ( Iterator i = blocks.iterator(); i.hasNext(); )
{
Block block = (Block) i.next();
block.traverse( sink );
}
after( sink );
}
/**
* <p>Getter for the field <code>blocks</code>.</p>
*
* @return a {@link java.util.List} object.
*/
public List getBlocks()
{
return blocks;
}
}
././@LongLink 0000000 0000000 0000000 00000000202 00000000000 011557 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000005213 11200507452 033410 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: SectionBlock.java 772533 2009-05-07 07:35:06Z ltheussl $
*/
class SectionBlock
implements Block
{
private Block text;
private int level;
SectionBlock( Block text, int level )
{
this.text = text;
this.level = level;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
if ( level == Sink.SECTION_LEVEL_1 )
{
sink.section1();
sink.sectionTitle1();
}
else if ( level == Sink.SECTION_LEVEL_2 )
{
sink.section2();
sink.sectionTitle2();
}
else if ( level == Sink.SECTION_LEVEL_3 )
{
sink.section3();
sink.sectionTitle3();
}
else if ( level == Sink.SECTION_LEVEL_4 )
{
sink.section4();
sink.sectionTitle4();
}
else if ( level == Sink.SECTION_LEVEL_5 )
{
sink.section5();
sink.sectionTitle5();
}
this.text.traverse( sink );
if ( level == Sink.SECTION_LEVEL_1 )
{
sink.sectionTitle1_();
sink.section1_();
}
else if ( level == Sink.SECTION_LEVEL_2 )
{
sink.sectionTitle2_();
sink.section2_();
}
else if ( level == Sink.SECTION_LEVEL_3 )
{
sink.sectionTitle3_();
sink.section3_();
}
else if ( level == Sink.SECTION_LEVEL_4 )
{
sink.sectionTitle4_();
sink.section4_();
}
else if ( level == Sink.SECTION_LEVEL_5 )
{
sink.sectionTitle5_();
sink.section5_();
}
}
}
././@LongLink 0000000 0000000 0000000 00000000203 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/VerbatimBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002637 11151264317 033424 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: VerbatimBlock.java 747837 2009-02-25 15:50:39Z ltheussl $
*/
class VerbatimBlock
implements Block
{
private String text;
VerbatimBlock( String text )
{
this.text = text;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( text );
sink.verbatim_();
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BoldBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002716 11167436114 033425 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* <p>BoldBlock class.</p>
*
* @version $Id: BoldBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class BoldBlock
extends AbstractFatherBlock
{
/**
* <p>Constructor for BoldBlock.</p>
*
* @param childBlocks the child blocks.
*/
public BoldBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.bold();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.bold_();
}
}
././@LongLink 0000000 0000000 0000000 00000000204 00000000000 011561 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinebreakBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002211 10767707462 033427 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @author Dave Syer
* @version $Id: LinebreakBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class LinebreakBlock
implements Block
{
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.lineBreak();
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/LinkBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002756 11167436114 033431 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @version $Id: LinkBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class LinkBlock
implements Block
{
private String reference;
private String text;
LinkBlock( String reference, String text )
{
if ( reference == null || text == null )
{
throw new IllegalArgumentException( "arguments can't be null" );
}
this.reference = reference;
this.text = text;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.link( reference );
sink.text( text );
sink.link_();
}
}
././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ItalicBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002500 10767707462 033430 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: ItalicBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class ItalicBlock
extends AbstractFatherBlock
{
ItalicBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.italic();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.italic_();
}
}
././@LongLink 0000000 0000000 0000000 00000000217 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/HorizontalRuleBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002727 11150513171 033416 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* <p>HorizontalRuleBlockParser class.</p>
*
* @version $Id: HorizontalRuleBlockParser.java 746983 2009-02-23 12:28:41Z vsiveton $
*/
public class HorizontalRuleBlockParser
implements BlockParser
{
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
return line.startsWith( "----" );
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
return new HorizontalRuleBlock();
}
}
././@LongLink 0000000 0000000 0000000 00000000204 00000000000 011561 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003275 11165345361 033427 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @author Juan F. Codagnone
* @version $Id: ParagraphBlock.java 761569 2009-04-03 08:38:09Z ltheussl $
*/
class ParagraphBlock
extends AbstractFatherBlock
{
private boolean generateParagraphTags = true;
ParagraphBlock( List blocks )
{
super( blocks );
}
ParagraphBlock( List blocks, boolean generateParagraphTags )
{
super( blocks );
this.generateParagraphTags = generateParagraphTags;
}
/** {@inheritDoc} */
public void before( Sink sink )
{
if ( this.generateParagraphTags )
{
sink.paragraph();
}
}
/** {@inheritDoc} */
public void after( Sink sink )
{
if ( this.generateParagraphTags )
{
sink.paragraph_();
}
}
}
././@LongLink 0000000 0000000 0000000 00000000210 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/SectionBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000004502 11200507452 033410 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* <p>SectionBlockParser class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: SectionBlockParser.java 772533 2009-05-07 07:35:06Z ltheussl $
*/
public class SectionBlockParser
implements BlockParser
{
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
if ( line.startsWith( "h1." ) )
{
return true;
}
else if ( line.startsWith( "h2." ) )
{
return true;
}
else if ( line.startsWith( "h3." ) )
{
return true;
}
else if ( line.startsWith( "h4." ) )
{
return true;
}
else if ( line.startsWith( "h5." ) )
{
return true;
}
return false;
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
int level = Integer.parseInt( Character.toString( line.charAt( 1 ) ) );
String title = line.substring( 3 ).trim();
BlockParser headingParser = new SectionBlockParser();
BlockParser figureParser = new FigureBlockParser();
BlockParser[] subparsers = new BlockParser[] { headingParser, figureParser };
return new SectionBlock( new ParagraphBlockParser( subparsers ).visit( title, source, false ), level );
}
}
././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/BlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003073 11216135717 033422 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.parser.ParseException;
/**
* <p>BlockParser interface.</p>
*
* @version $Id: BlockParser.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public interface BlockParser
{
/**
* accept.
*
* @param line the line.
* @param source the source.
* @return boolean true if valid.
*/
boolean accept( String line, ByLineSource source );
/**
* visit.
*
* @param line the line.
* @param source the source.
* @return boolean true if valid.
* @throws org.apache.maven.doxia.parser.ParseException if any.
*/
Block visit( String line, ByLineSource source ) throws ParseException;
}
././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/AnchorBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002551 11167436114 033422 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* @version $Id: AnchorBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class AnchorBlock
implements Block
{
private String name;
AnchorBlock( String name )
{
if ( name == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
this.name = name;
}
/** {@inheritDoc} */
public void traverse( Sink sink )
{
sink.anchor( name );
sink.anchor_();
}
}
././@LongLink 0000000 0000000 0000000 00000000207 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/FigureBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000006034 11167605023 033417 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineSource;
/**
* <p>FigureBlockParser class.</p>
*
* @version $Id: FigureBlockParser.java 763889 2009-04-10 08:57:55Z bentmann $
* @since 1.1
*/
public class FigureBlockParser
implements BlockParser
{
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
return line.startsWith( "!" ) && line.lastIndexOf( "!" ) > 1;
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
String image = line.substring( 1, line.lastIndexOf( "!" ) );
if ( image.indexOf( "|" ) >= 0 )
{
// DOXIA-303: handle figure attributes
image = image.substring( 0, image.indexOf( "|" ) );
}
line = line.substring( line.lastIndexOf( "!" ) + 1 ).trim();
if ( line.startsWith( "\\\\" ) )
{
// ignore linebreak at start of caption
line = line.substring( 2 );
}
String caption = line + appendUntilEmptyLine( source );
if ( caption.trim().length() > 0 )
{
return new FigureBlock( image, caption );
}
return new FigureBlock( image );
}
/**
* Slurp lines from the source starting with the given line appending them together into a StringBuffer until an
* empty line is reached, and while the source contains more lines.
*
* @param source the source to read new lines from
* @return a StringBuffer appended with lines
* @throws ParseException
*/
private String appendUntilEmptyLine( ByLineSource source )
throws ParseException
{
StringBuffer text = new StringBuffer();
String line;
while ( ( line = source.getNextLine() ) != null )
{
if ( line.trim().length() == 0 )
{
break;
}
if ( text.length() == 0 )
{
text.append( line.trim() );
}
else
{
text.append( " " + line.trim() );
}
}
return text.toString();
}
}
././@LongLink 0000000 0000000 0000000 00000000212 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ParagraphBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000010235 11203262772 033416 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.util.ByLineSource;
/**
* <p>ParagraphBlockParser class.</p>
*
* @version $Id: ParagraphBlockParser.java 775115 2009-05-15 12:54:18Z ltheussl $
*/
public class ParagraphBlockParser
implements BlockParser
{
private BlockParser[] parsers;
/**
* <p>Constructor for ParagraphBlockParser.</p>
*
* @param parsers the parsers.
*/
public ParagraphBlockParser( BlockParser[] parsers )
{
super();
this.parsers = parsers;
}
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
return true;
}
/**
* Visit the Block.
*
* @param line the line to visit.
* @param source the source.
* @param generateParagraphTags whether to generate a paragraph.
* @return the visited Block.
*
* @throws org.apache.maven.doxia.parser.ParseException if any
*/
public Block visit( String line, ByLineSource source, boolean generateParagraphTags )
throws ParseException
{
if ( generateParagraphTags )
{
return this.visit( line, source );
}
else
{
ChildBlocksBuilder builder = new ChildBlocksBuilder( line );
return new ParagraphBlock( builder.getBlocks(), generateParagraphTags );
}
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
ChildBlocksBuilder builder = new ChildBlocksBuilder( appendUntilEmptyLine( line, source ) );
return new ParagraphBlock( builder.getBlocks() );
}
/**
* Slurp lines from the source starting with the given line appending them together into a StringBuffer until an
* empty line is reached, and while the source contains more lines. The result can be passed to the
* {@link #getBlocks(String)} method.
*
* @param line the first line
* @param source the source to read new lines from
* @return a StringBuffer appended with lines
* @throws ParseException
*/
private String appendUntilEmptyLine( String line, ByLineSource source )
throws ParseException
{
StringBuffer text = new StringBuffer();
do
{
if ( line.trim().length() == 0 )
{
break;
}
boolean accepted = false;
for ( int i = 0; i < parsers.length; i++ )
{
BlockParser parser = parsers[i];
if ( parser.accept( line, source ) )
{
accepted = true;
break;
}
}
if ( accepted )
{
// Slightly fragile - if any of the parsers need to do this in order to decide whether to accept a line,
// then it will barf because of the contract of ByLineSource
source.ungetLine();
break;
}
if ( text.length() == 0 )
{
text.append( line.trim() );
}
else
{
text.append( " " + line.trim() );
}
}
while ( ( line = source.getNextLine() ) != null );
return text.toString();
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000755 0001750 0001750 00000000000 11632765557 033432 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000214 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/NumberedListBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002705 11204733376 033425 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* <p>NumberedListBlock class.</p>
*
* @version $Id: NumberedListBlock.java 776605 2009-05-20 07:53:34Z ltheussl $
*/
public class NumberedListBlock
extends ListBlock
{
/**
* @param childBlocks
*/
NumberedListBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.numberedList( Sink.NUMBERING_DECIMAL );
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.numberedList_();
}
}
././@LongLink 0000000 0000000 0000000 00000000212 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeListBuilder.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000007444 11167436114 033430 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.maven.doxia.module.confluence.parser.ChildBlocksBuilder;
/**
* <p>TreeListBuilder class.</p>
*
* @version $Id: TreeListBuilder.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class TreeListBuilder
{
private TreeComponent root;
private TreeComponent current;
TreeListBuilder()
{
root = new TreeComponent( null, "root", 0 );
current = root;
}
void feedEntry( int type, int level, String text )
{
int currentDepth = current.getDepth();
int incomingLevel = level - 1;
if ( incomingLevel == currentDepth )
{
// nothing to move
}
else if ( incomingLevel > currentDepth )
{
// el actual ahora es el �ltimo que insert�
List components = current.getChildren();
if ( components.size() == 0 )
{
/* for example:
* * item1
* * item2
*/
for ( int i = 0, n = incomingLevel - currentDepth; i < n; i++ )
{
current = current.addChildren( "", type );
}
}
else
{
current = (TreeComponent) components.get( components.size() - 1 );
}
}
else
{
for ( int i = 0, n = currentDepth - incomingLevel; i < n; i++ )
{
current = current.getFather();
if ( current == null )
{
throw new IllegalStateException();
}
}
}
current.addChildren( text.trim(), type );
}
ListBlock getBlock()
{
return getList( root );
}
private ListBlock getList( TreeComponent treeComponent )
{
List list = getListItems( treeComponent );
int type = ( (TreeComponent) treeComponent.getChildren().get( 0 ) ).getType();
if ( type == ListBlockParser.BULLETED_LIST )
{
return new BulletedListBlock( list );
}
return new NumberedListBlock( list );
}
private List getListItems( TreeComponent tc )
{
List blocks = new ArrayList();
for ( Iterator i = tc.getChildren().iterator(); i.hasNext(); )
{
TreeComponent child = (TreeComponent) i.next();
List childBlocks = new ArrayList();
if ( child.getFather() != null )
{
childBlocks.addAll( new ChildBlocksBuilder( child.getText() ).getBlocks() );
}
if ( child.getChildren().size() != 0 )
{
blocks.add( new ListItemBlock( childBlocks, getList( child ) ) );
}
else
{
blocks.add( new ListItemBlock( childBlocks ) );
}
}
return blocks;
}
}
././@LongLink 0000000 0000000 0000000 00000000210 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/TreeComponent.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000005376 10767707462 033446 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: TreeComponent.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class TreeComponent
{
private static final String EOL = System.getProperty( "line.separator" );
private List children = new ArrayList();
private String text;
private TreeComponent father;
private int type;
TreeComponent( TreeComponent father, String text, int type )
{
this.text = text;
this.father = father;
this.type = type;
}
List getChildren()
{
return children;
}
TreeComponent addChildren( String t, int ttype )
{
if ( t == null )
{
throw new IllegalArgumentException( "argument is null" );
}
TreeComponent ret = new TreeComponent( this, t, ttype );
children.add( ret );
return ret;
}
TreeComponent getFather()
{
return father;
}
int getDepth()
{
int ret = 0;
TreeComponent c = this;
while ( ( c = c.getFather() ) != null )
{
ret++;
}
return ret;
}
/** {@inheritDoc} */
public String toString()
{
return toString( "" );
}
String toString( String indent )
{
StringBuffer sb = new StringBuffer();
if ( father != null )
{
sb.append( indent );
sb.append( "- " );
sb.append( text );
sb.append( EOL );
}
for ( Iterator i = children.iterator(); i.hasNext(); )
{
TreeComponent lc = (TreeComponent) i.next();
sb.append( lc.toString( indent + " " ) );
}
return sb.toString();
}
String getText()
{
return text;
}
int getType()
{
return type;
}
}
././@LongLink 0000000 0000000 0000000 00000000212 00000000000 011560 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlockParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000010111 11375706236 033417 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.ByLineSource;
import org.apache.maven.doxia.module.confluence.parser.Block;
import org.apache.maven.doxia.module.confluence.parser.BlockParser;
import org.apache.maven.doxia.parser.ParseException;
/**
* <p>ListBlockParser class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: ListBlockParser.java 947266 2010-05-22 07:49:50Z ltheussl $
*/
public class ListBlockParser
implements BlockParser
{
/** Constant <code>BULLETED_LIST=0</code> */
public static final int BULLETED_LIST = 0;
/** Constant <code>NUMBERED_LIST=1</code> */
public static final int NUMBERED_LIST = 1;
/** {@inheritDoc} */
public boolean accept( String line, ByLineSource source )
{
if ( isList( line ) )
{
return true;
}
return false;
}
/** {@inheritDoc} */
public Block visit( String line, ByLineSource source )
throws ParseException
{
TreeListBuilder treeListBuilder = new TreeListBuilder();
StringBuffer text = new StringBuffer();
do
{
if ( line.trim().length() == 0 )
{
break;
}
if ( text.length() > 0 && isList( line ) )
{
// We reached a new line with list prefix
addItem( treeListBuilder, text );
}
if ( text.length() == 0 )
{
text.append( line.trim() );
}
else
{
text.append( " " + line.trim() );
}
}
while ( ( line = source.getNextLine() ) != null );
if ( text.length() > 0 )
{
addItem( treeListBuilder, text );
}
return treeListBuilder.getBlock();
}
private void addItem( TreeListBuilder treeListBuilder, StringBuffer text )
{
String item = text.toString();
int level = getLevel( item );
if ( isBulletedList( item, level - 1 ) )
{
treeListBuilder.feedEntry( BULLETED_LIST, level, item.substring( level ) );
}
else
{
treeListBuilder.feedEntry( NUMBERED_LIST, level, item.substring( level ) );
}
text.setLength( 0 );
}
private int getLevel( String line )
{
int level = 0;
while ( line.charAt( level ) == '*' || line.charAt( level ) == '-' || line.charAt( level ) == '#' )
{
level++;
}
return level;
}
private boolean isBulletedList( String line, int deph )
{
return ( line.charAt( deph ) == '*' || line.charAt( deph ) == '-' );
}
private boolean isList( String line )
{
line = line.trim();
if ( line.startsWith( "*" ) || line.startsWith( "-" ) || line.startsWith( "#" ) )
{
String temp = line.substring( 1 );
while ( temp.length() > 0 && ( temp.charAt( 0 ) == '*' || temp.charAt( 0 ) == '-' || temp.charAt( 0 ) == '#' ) )
{
temp = temp.substring( 1 );
}
if ( temp.length() > 0 && temp.charAt( 0 ) == ' ' )
{
return true;
}
}
return false;
}
}
././@LongLink 0000000 0000000 0000000 00000000204 00000000000 011561 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002344 10767707462 033436 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.confluence.parser.AbstractFatherBlock;
import java.util.List;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: ListBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
abstract class ListBlock
extends AbstractFatherBlock
{
ListBlock( List childBlocks )
{
super( childBlocks );
}
}
././@LongLink 0000000 0000000 0000000 00000000214 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/BulletedListBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002604 10767707462 033435 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: BulletedListBlock.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class BulletedListBlock
extends ListBlock
{
BulletedListBlock( List childBlocks )
{
super( childBlocks );
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.list();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
sink.list_();
}
}
././@LongLink 0000000 0000000 0000000 00000000210 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/list/ListItemBlock.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000003337 11167436114 033425 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser.list;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.confluence.parser.AbstractFatherBlock;
import org.apache.maven.doxia.sink.Sink;
import java.util.List;
/**
* @version $Id: ListItemBlock.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
class ListItemBlock
extends AbstractFatherBlock
{
private ListBlock innerList;
ListItemBlock( List blocks )
{
this( blocks, null );
}
ListItemBlock( List blocks, ListBlock innerList )
{
super( blocks );
this.innerList = innerList;
}
/** {@inheritDoc} */
public void before( Sink sink )
{
sink.listItem();
}
/** {@inheritDoc} */
public void after( Sink sink )
{
if ( innerList != null )
{
innerList.traverse( sink );
}
sink.listItem_();
}
ListBlock getInnerList()
{
return innerList;
}
}
././@LongLink 0000000 0000000 0000000 00000000173 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/Block.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000002247 11216135717 033424 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
/**
* <p>Block interface.</p>
*
* @version $Id: Block.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public interface Block
{
/**
* <p>traverse.</p>
*
* @param sink a {@link org.apache.maven.doxia.sink.Sink} object.
*/
void traverse( Sink sink );
}
././@LongLink 0000000 0000000 0000000 00000000210 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/parser/ChildBlocksBuilder.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000024112 11201374105 033405 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.ArrayList;
import java.util.List;
import org.codehaus.plexus.util.StringUtils;
/**
* Re-usable builder that can be used to generate paragraph and list item text from a string containing all the content
* and wiki formatting. This class is intentionally stateful, but cheap to create, so create one as needed and keep it
* on the stack to preserve stateless behaviour in the caller.
*
* @author Dave Syer
* @version $Id: ChildBlocksBuilder.java 773275 2009-05-09 21:40:21Z hboutemy $
* @since 1.1
*/
public class ChildBlocksBuilder
{
private boolean insideBold = false;
private boolean insideItalic = false;
private boolean insideLink = false;
private List blocks = new ArrayList();
private StringBuffer text = new StringBuffer();
private String input;
private boolean insideMonospaced;
/**
* <p>Constructor for ChildBlocksBuilder.</p>
*
* @param input the input.
*/
public ChildBlocksBuilder( String input )
{
this.input = input;
}
/**
* Utility method to convert marked up content into blocks for rendering.
*
* @return a list of Blocks that can be used to render it
*/
public List getBlocks()
{
List specialBlocks = new ArrayList();
for ( int i = 0; i < input.length(); i++ )
{
char c = input.charAt( i );
switch ( c )
{
case '*':
if ( insideBold )
{
insideBold = false;
specialBlocks = getList( new BoldBlock( getChildren( text, specialBlocks ) ), specialBlocks );
text = new StringBuffer();
}
else
{
text = addTextBlockIfNecessary( blocks, specialBlocks, text );
insideBold = true;
}
break;
case '_':
if ( insideItalic )
{
insideItalic = false;
specialBlocks = getList( new ItalicBlock( getChildren( text, specialBlocks ) ), specialBlocks );
text = new StringBuffer();
}
else
{
text = addTextBlockIfNecessary( blocks, specialBlocks, text );
insideItalic = true;
}
break;
case '[':
insideLink = true;
text = addTextBlockIfNecessary( blocks, specialBlocks, text );
break;
case ']':
if ( insideLink )
{
boolean addHTMLSuffix = false;
String link = text.toString();
if ( !link.endsWith( ".html" ) )
{
if ( link.indexOf( "http" ) < 0 )
{
addHTMLSuffix = true;
}
}
if ( link.indexOf( "|" ) > 0 )
{
String[] pieces = StringUtils.split( text.toString(), "|" );
if ( addHTMLSuffix )
{
if ( pieces[1].indexOf( "#" ) < 0 )
{
pieces[1] = pieces[1].concat( ".html" );
}
else
{
if ( !pieces[1].startsWith( "#" ) )
{
String[] temp = pieces[1].split( "#" );
pieces[1] = temp[0] + ".html#" + temp[1];
}
}
}
blocks.add( new LinkBlock( pieces[1], pieces[0] ) );
}
else
{
String value = link;
if ( link.startsWith( "#" ) )
{
value = link.substring( 1 );
}
if ( addHTMLSuffix )
{
if ( link.indexOf( "#" ) < 0 )
{
link = link.concat( ".html" );
}
else
{
if ( !link.startsWith( "#" ) )
{
String[] temp = link.split( "#" );
link = temp[0] + ".html#" + temp[1];
}
}
}
blocks.add( new LinkBlock( link, value ) );
}
text = new StringBuffer();
insideLink = false;
}
break;
case '{':
text = addTextBlockIfNecessary( blocks, specialBlocks, text );
if ( charAt( input, i ) == '{' ) // it's monospaced
{
i++;
insideMonospaced = true;
}
// else it's a confluence macro...
break;
case '}':
// System.out.println( "line = " + line );
if ( charAt( input, i ) == '}' )
{
i++;
insideMonospaced = false;
specialBlocks = getList( new MonospaceBlock( getChildren( text, specialBlocks ) ),
specialBlocks );
text = new StringBuffer();
}
else
{
String name = text.toString();
if ( name.startsWith( "anchor:" ) )
{
blocks.add( new AnchorBlock( name.substring( "anchor:".length() ) ) );
}
else
{
blocks.add( new TextBlock( "{" + name + "}" ) );
}
text = new StringBuffer();
}
break;
case '\\':
// System.out.println( "line = " + line );
if ( charAt( input, i ) == '\\' )
{
i++;
text = addTextBlockIfNecessary( blocks, specialBlocks, text );
blocks.add( new LinebreakBlock() );
}
else
{
i++;
text.append( input.charAt( i ) );
}
break;
default:
text.append( c );
}
if ( !specialBlocks.isEmpty() )
{
if ( !insideItalic && !insideBold && !insideMonospaced )
{
blocks.addAll( specialBlocks );
specialBlocks.clear();
}
}
}
if ( text.length() > 0 )
{
blocks.add( new TextBlock( text.toString() ) );
}
return blocks;
}
private List getList( Block block, List currentBlocks )
{
List list = new ArrayList();
if ( insideBold || insideItalic || insideMonospaced )
{
list.addAll( currentBlocks );
}
list.add( block );
return list;
}
private List getChildren( StringBuffer buffer, List currentBlocks )
{
String txt = buffer.toString().trim();
if ( currentBlocks.isEmpty() && StringUtils.isEmpty( txt ) )
{
return new ArrayList();
}
ArrayList list = new ArrayList();
if ( !insideBold && !insideItalic && !insideMonospaced )
{
list.addAll( currentBlocks );
}
if ( StringUtils.isEmpty( txt ) )
{
return list;
}
list.add( new TextBlock( txt ) );
return list;
}
private static char charAt( String input, int i )
{
return input.length() > i + 1 ? input.charAt( i + 1 ) : '\0';
}
private StringBuffer addTextBlockIfNecessary( List blcks, List specialBlocks, StringBuffer txt )
{
if ( txt.length() == 0 )
{
return txt;
}
TextBlock textBlock = new TextBlock( txt.toString() );
if ( !insideBold && !insideItalic && !insideMonospaced )
{
blcks.add( textBlock );
}
else
{
specialBlocks.add( textBlock );
}
return new StringBuffer();
}
}
././@LongLink 0000000 0000000 0000000 00000000177 00000000000 011572 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/confluence/ConfluenceParser.java doxia-1.1.4/doxia-modules/doxia-module-confluence/src/main/java/org/apache/maven/doxia/module/conflu0000644 0001750 0001750 00000012347 11375444145 033432 0 ustar twerner twerner package org.apache.maven.doxia.module.confluence;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Reader;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import org.apache.maven.doxia.module.confluence.parser.Block;
import org.apache.maven.doxia.module.confluence.parser.BlockParser;
import org.apache.maven.doxia.module.confluence.parser.DefinitionListBlockParser;
import org.apache.maven.doxia.module.confluence.parser.FigureBlockParser;
import org.apache.maven.doxia.module.confluence.parser.HorizontalRuleBlockParser;
import org.apache.maven.doxia.module.confluence.parser.ParagraphBlockParser;
import org.apache.maven.doxia.module.confluence.parser.SectionBlockParser;
import org.apache.maven.doxia.module.confluence.parser.VerbatimBlockParser;
import org.apache.maven.doxia.module.confluence.parser.list.ListBlockParser;
import org.apache.maven.doxia.module.confluence.parser.table.TableBlockParser;
import org.apache.maven.doxia.parser.AbstractTextParser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.ByLineReaderSource;
import org.apache.maven.doxia.util.ByLineSource;
/**
* Parse the <a href="http://www.atlassian.com/software/confluence/">Confluence</a>.
* See <a href="http://confluence.atlassian.com/display/CONF25/Confluence+Notation+Guide+Overview">
* Confluence Notation Guide Overview</a>
*
* @version $Id: ConfluenceParser.java 946935 2010-05-21 08:46:29Z ltheussl $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="confluence"
*/
public class ConfluenceParser
extends AbstractTextParser
{
private BlockParser[] parsers;
/**
* <p>Constructor for ConfluenceParser.</p>
*/
public ConfluenceParser()
{
init();
}
private List parse( ByLineSource source )
throws ParseException
{
init();
List blocks = new ArrayList();
String line;
while ( ( line = source.getNextLine() ) != null )
{
boolean accepted = false;
for ( int i = 0; i < parsers.length; i++ )
{
BlockParser parser = parsers[i];
if ( line.trim().length() == 0 )
{
continue;
}
if ( parser.accept( line, source ) )
{
accepted = true;
blocks.add( parser.visit( line, source ) );
break;
}
}
/*
if ( !accepted )
{
throw new ParseException( "don't know how to handle line: " + source.getLineNumber() + ": " + line );
}
*/
}
return blocks;
}
/** {@inheritDoc} */
public synchronized void parse( Reader source, Sink sink )
throws ParseException
{
ByLineSource src = new ByLineReaderSource( source );
try
{
List blocks = parse( src );
sink.head();
sink.head_();
sink.body();
for ( Iterator i = blocks.iterator(); i.hasNext(); )
{
Block block = (Block) i.next();
block.traverse( sink );
}
sink.body_();
}
catch ( Exception e )
{
// TODO handle column number
throw new ParseException( e, src.getName(), src.getLineNumber(), -1 );
}
finally
{
setSecondParsing( false );
init();
}
}
/** {@inheritDoc} */
protected void init()
{
super.init();
BlockParser headingParser = new SectionBlockParser();
BlockParser figureParser = new FigureBlockParser();
BlockParser verbatimParser = new VerbatimBlockParser();
BlockParser definitionParser = new DefinitionListBlockParser();
BlockParser horizontalRuleParser = new HorizontalRuleBlockParser();
BlockParser listParser = new ListBlockParser();
BlockParser tableParser = new TableBlockParser();
BlockParser[] subparsers =
new BlockParser[] { headingParser, figureParser, listParser, tableParser, verbatimParser };
BlockParser paragraphParser = new ParagraphBlockParser( subparsers );
this.parsers =
new BlockParser[] { headingParser, figureParser, verbatimParser, definitionParser, horizontalRuleParser,
listParser, tableParser, paragraphParser };
}
}
doxia-1.1.4/doxia-modules/src/ 0000755 0001750 0001750 00000000000 11632765557 016141 5 ustar twerner twerner doxia-1.1.4/doxia-modules/src/site/ 0000755 0001750 0001750 00000000000 11632765557 017105 5 ustar twerner twerner doxia-1.1.4/doxia-modules/src/site/site.xml 0000644 0001750 0001750 00000001725 11103330660 020550 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
-->
<project>
<body>
<menu ref="parent"/>
<menu ref="modules"/>
<menu ref="reports"/>
</body>
</project> doxia-1.1.4/doxia-modules/doxia-module-latex/ 0000755 0001750 0001750 00000000000 11632765556 021053 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/pom.xml 0000644 0001750 0001750 00000003030 11470562366 022356 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia-modules</artifactId>
<groupId>org.apache.maven.doxia</groupId>
<version>1.1.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>doxia-module-latex</artifactId>
<name>Doxia :: Latex Module</name>
<description>A Doxia module for LaTeX source documents.</description>
<dependencies>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>
</dependencies>
</project> doxia-1.1.4/doxia-modules/doxia-module-latex/src/ 0000755 0001750 0001750 00000000000 11632765556 021642 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/ 0000755 0001750 0001750 00000000000 11632765556 022621 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/ 0000755 0001750 0001750 00000000000 11632765556 023542 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765556 024331 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765556 025552 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765556 026660 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765556 027764 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765556 031251 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/maven/doxia/module/latex/ 0000755 0001750 0001750 00000000000 11632765556 032366 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000162 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/maven/doxia/module/latex/LatexSinkTest.java doxia-1.1.4/doxia-modules/doxia-module-latex/src/test/java/org/apache/maven/doxia/module/latex/Latex0000644 0001750 0001750 00000015443 11230053175 033352 0 ustar twerner twerner package org.apache.maven.doxia.module.latex;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.AbstractSinkTest;
/**
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: LatexSinkTest.java 795033 2009-07-17 10:46:21Z ltheussl $
*/
public class LatexSinkTest
extends AbstractSinkTest
{
/** {@inheritDoc} */
protected String outputExtension()
{
return "tex";
}
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new LatexSink( writer );
}
/** {@inheritDoc} */
protected boolean isXmlSink()
{
return false;
}
/** {@inheritDoc} */
protected String getTitleBlock( String title )
{
return "\\title{" + LatexSink.escaped( title ) + "}" + EOL;
}
/** {@inheritDoc} */
protected String getAuthorBlock( String author )
{
return "\\author{" + LatexSink.escaped( author ) + "}" + EOL;
}
/** {@inheritDoc} */
protected String getDateBlock( String date )
{
return "\\date{" + LatexSink.escaped( date ) + "}" + EOL;
}
/** {@inheritDoc} */
protected String getHeadBlock()
{
return ( (LatexSink) getSink() ).defaultSinkCommands()
+ "\\documentclass[a4paper]{article}" + EOL + EOL
+ ( (LatexSink) getSink() ).defaultPreamble()
+ "\\begin{document}" + EOL + EOL;
}
/** {@inheritDoc} */
protected String getBodyBlock()
{
return "\\end{document}" + EOL;
}
/** {@inheritDoc} */
protected String getSectionTitleBlock( String title )
{
return title;
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return EOL + "\\section{" + title + "}" + EOL;
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return EOL + "\\subsection{" + title + "}" + EOL;
}
/** {@inheritDoc} */
protected String getSection3Block( String title )
{
return EOL + "\\subsubsection{" + title + "}" + EOL;
}
/** {@inheritDoc} */
protected String getSection4Block( String title )
{
return EOL + "\\paragraph{" + title + "}" + EOL;
}
/** {@inheritDoc} */
protected String getSection5Block( String title )
{
return EOL + "\\subparagraph{" + title + "}" + EOL;
}
/** {@inheritDoc} */
protected String getListBlock( String item )
{
return EOL + "\\begin{itemize}" + EOL + "\\item " + LatexSink.escaped( item ) + EOL + "\\end{itemize}" + EOL;
}
/** {@inheritDoc} */
protected String getNumberedListBlock( String item )
{
return EOL + "\\begin{enumerate}" + EOL + "\\renewcommand{\\theenumi}{\\roman{enumi}}" + EOL + "\\item "
+ LatexSink.escaped( item ) + EOL + "\\end{enumerate}" + EOL;
}
/** {@inheritDoc} */
protected String getDefinitionListBlock( String definum, String definition )
{
return EOL + "\\begin{description}" + EOL + "\\item[\\mbox{" + definum + "}] "
+ definition + EOL + "\\end{description}" + EOL;
}
/** {@inheritDoc} */
protected String getFigureBlock( String source, String caption )
{
return EOL + "\\begin{figure}[htb]" + EOL + "\\begin{center}" + EOL + "\\includegraphics{" + source + "}" + EOL
+ "\\end{center}" + EOL + "\\caption{Figure\\_caption}" + EOL + "\\end{figure}" + EOL;
}
/** {@inheritDoc} */
protected String getTableBlock( String cell, String caption )
{
return EOL + "\\begin{table}[htp]" + EOL + "\\begin{center}" + EOL + "\\begin{tabular}{c}" + EOL
+ "\\begin{tabular}[t]{c}cell\\end{tabular}\\\\" + EOL + "\\end{tabular}" + EOL
+ "\\end{center}" + EOL + "\\caption{Table\\_caption}" + EOL + "\\end{table}" + EOL;
}
/** {@inheritDoc} */
protected String getParagraphBlock( String text )
{
return EOL + EOL + text + EOL;
}
/** {@inheritDoc} */
protected String getVerbatimBlock( String text )
{
return EOL + "\\begin{small}" + EOL + "\\begin{Verbatim}[frame=single]" + EOL + text + EOL
+ "\\end{Verbatim}" + EOL + "\\end{small}" + EOL;
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return EOL + "\\begin{center}\\rule[0.5ex]{\\linewidth}{1pt}\\end{center}" + EOL;
}
/** {@inheritDoc} */
protected String getPageBreakBlock()
{
return EOL + "\\newpage" + EOL;
}
/** {@inheritDoc} */
protected String getAnchorBlock( String anchor )
{
return "\\hypertarget{" + anchor + "}{" + anchor + "}";
}
/** {@inheritDoc} */
protected String getLinkBlock( String link, String text )
{
return "\\hyperlink{" + link + "}{" + text + "}";
}
/** {@inheritDoc} */
protected String getItalicBlock( String text )
{
return "\\textit{" + text + "}";
}
/** {@inheritDoc} */
protected String getBoldBlock( String text )
{
return "\\textbf{" + text + "}";
}
/** {@inheritDoc} */
protected String getMonospacedBlock( String text )
{
return "\\texttt{\\small " + text + "}";
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return "\\newline" + EOL;
}
/** {@inheritDoc} */
protected String getNonBreakingSpaceBlock()
{
return "~";
}
/** {@inheritDoc} */
protected String getTextBlock( String text )
{
// TODO: how to retrieve those outside the sink?
return "\\textasciitilde" + EOL + ",\\_=,\\_\\symbol{45},\\_+,\\_*,\\_[,\\_],"
+ "\\_\\symbol{60},\\_\\symbol{62},\\_\\{,\\_\\},\\_\\textbackslash";
}
/** {@inheritDoc} */
protected String getRawTextBlock( String text )
{
return "~,_=,_-,_+,_*,_[,_],_<,_>,_{,_},_\\";
}
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
return EOL + "% Simple comment with ----";
}
}
doxia-1.1.4/doxia-modules/doxia-module-latex/src/site/ 0000755 0001750 0001750 00000000000 11632765556 022606 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 024253 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
-->
<project>
<body>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project> doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/ 0000755 0001750 0001750 00000000000 11632765556 022566 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/ 0000755 0001750 0001750 00000000000 11632765556 024600 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/ 0000755 0001750 0001750 00000000000 11632765556 025367 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/ 0000755 0001750 0001750 00000000000 11632765556 026610 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765556 027716 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765556 031022 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765556 032307 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000145 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/latex/ doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/latex/0000755 0001750 0001750 00000000000 11632765556 033424 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000171 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/latex/default_preamble.tex doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/latex/0000644 0001750 0001750 00000000513 10772432067 033415 0 ustar twerner twerner % required (do not remove!):
\usepackage{graphics} % for images
\usepackage{fancyvrb} % for verbatim
\usepackage[colorlinks=true,urlcolor=blue,linkcolor=green]{hyperref} % for links and anchors
% optional:
\usepackage{times}
\usepackage[latin1]{inputenc}
\pagestyle{plain}
\setlength{\parindent}{0pt}
\setlength{\parskip}{1ex}
././@LongLink 0000000 0000000 0000000 00000000176 00000000000 011571 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/latex/default_sink_commands.tex doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/resources/org/apache/maven/doxia/module/latex/0000644 0001750 0001750 00000000000 10772432067 033404 0 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/ 0000755 0001750 0001750 00000000000 11632765556 023507 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765556 024276 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765556 025517 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765556 026625 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765556 027731 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765556 031216 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/ 0000755 0001750 0001750 00000000000 11632765556 032333 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSinkFactory.java doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/Latex0000644 0001750 0001750 00000003157 11105660512 033316 0 ustar twerner twerner package org.apache.maven.doxia.module.latex;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractTextSinkFactory;
import org.apache.maven.doxia.sink.Sink;
/**
* Latex implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: LatexSinkFactory.java 712574 2008-11-09 22:16:42Z hboutemy $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="latex"
*/
public class LatexSinkFactory
extends AbstractTextSinkFactory
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding )
{
// TODO: can encoding safely be ignored? Shouldn't it be written into the generated Latex source
// as inputenc package parameter?
return new LatexSink( writer );
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/LatexSink.java doxia-1.1.4/doxia-modules/doxia-module-latex/src/main/java/org/apache/maven/doxia/module/latex/Latex0000644 0001750 0001750 00000076566 11244502114 033331 0 ustar twerner twerner package org.apache.maven.doxia.module.latex;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.AbstractTextSink;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.doxia.util.LineBreaker;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import java.io.IOException;
import java.io.InputStream;
import java.io.Writer;
import java.util.Locale;
/**
* Latex Sink implementation.
* <br/>
* <b>Note</b>: The encoding used is UTF-8.
*
* @version $Id: LatexSink.java 807174 2009-08-24 12:15:08Z vsiveton $
* @since 1.0
*/
public class LatexSink
extends AbstractTextSink
{
/**
* Flag that indicates if the document to be written is only a fragment.
*
* This implies that <code>\\begin{document}</code>, <code>\\title{..}</code> will not be output.
*/
private final boolean fragmentDocument;
private boolean ignoreText;
private final LineBreaker out;
private final String sinkCommands;
private final String preamble;
private boolean titleFlag;
private int numberedListNesting;
private boolean verbatimFlag;
private boolean figureFlag;
private boolean tableFlag;
private boolean gridFlag;
private int[] cellJustif;
private int cellCount;
private boolean isTitle;
private String title;
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* Constructor, initialize the Writer and the variables.
*
* @param out not null writer to write the result. <b>Should</b> be an UTF-8 Writer.
* You could use <code>newWriter</code> methods from {@link org.codehaus.plexus.util.WriterFactory}.
*/
protected LatexSink( Writer out )
{
this( out, null, null );
}
/**
* Constructor, initialize the Writer and the variables.
*
* @param out not null writer to write the result. <b>Should</b> be an UTF-8 Writer.
* You could use <code>newWriter</code> methods from {@link org.codehaus.plexus.util.WriterFactory}.
* @param sinkCommands A String representation of commands that go before \documentclass.
* @param preamble A String representation of commands that go between \documentclass and \begin{document}.
*/
protected LatexSink( Writer out, String sinkCommands, String preamble )
{
this( out, sinkCommands, preamble, false );
}
/**
* Constructor, initialize the Writer and the variables.
*
* @param out not null writer to write the result. <b>Should</b> be an UTF-8 Writer.
* You could use <code>newWriter</code> methods from {@link org.codehaus.plexus.util.WriterFactory}.
* @param sinkCommands A String representation of commands that go before \documentclass.
* @param preamble A String representation of commands that go between \documentclass and \begin{document}.
* @param fragmentDocument If this receives events that that are only part of a document.
* Typically, headers are omitted if this is true.
*/
protected LatexSink( Writer out, String sinkCommands, String preamble, boolean fragmentDocument )
{
this.out = new LineBreaker( out );
if ( sinkCommands == null )
{
sinkCommands = defaultSinkCommands();
}
if ( preamble == null )
{
preamble = defaultPreamble();
}
this.sinkCommands = sinkCommands;
this.preamble = preamble;
this.fragmentDocument = fragmentDocument;
init();
}
// ----------------------------------------------------------------------
// Overridables
// ----------------------------------------------------------------------
/**
* Returns a default \documentclass declaration.
*
* @return String.
*/
protected String getDocumentStart()
{
return "\\documentclass[a4paper]{article}" + EOL + EOL;
}
/**
* Returns a default \begin{document} declaration.
*
* @return String.
*/
protected String getDocumentBegin()
{
return "\\begin{document}" + EOL + EOL;
}
/**
* Returns a default \end{document} declaration.
*
* @return String.
*/
protected String getDocumentEnd()
{
return "\\end{document}" + EOL;
}
// ----------------------------------------------------------------------
// Sink Implementation
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void head()
{
head( null );
}
/** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
init();
if ( !fragmentDocument )
{
markup( sinkCommands );
markup( getDocumentStart() );
markup( preamble );
markup( getDocumentBegin() );
}
}
/**
* {@inheritDoc}
*/
public void body()
{
body( null );
}
/** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
if ( titleFlag )
{
if ( fragmentDocument )
{
markup( "\\section" );
}
else
{
titleFlag = false;
markup( "\\maketitle" + EOL + EOL );
}
}
}
/**
* {@inheritDoc}
*/
public void body_()
{
if ( !fragmentDocument )
{
markup( getDocumentEnd() );
}
flush();
}
/**
* {@inheritDoc}
*/
public void title()
{
title( null );
}
/** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
if ( !fragmentDocument )
{
titleFlag = true;
markup( "\\title{" );
}
else
{
ignoreText = true;
}
}
/**
* {@inheritDoc}
*/
public void title_()
{
if ( !fragmentDocument )
{
markup( "}" + EOL );
}
else
{
ignoreText = false;
}
}
/**
* {@inheritDoc}
*/
public void author()
{
author( null );
}
/** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
if ( !fragmentDocument )
{
markup( "\\author{" );
}
else
{
ignoreText = true;
}
}
/**
* {@inheritDoc}
*/
public void author_()
{
if ( !fragmentDocument )
{
markup( "}" + EOL );
}
else
{
ignoreText = false;
}
}
/**
* {@inheritDoc}
*/
public void date()
{
date( null );
}
/** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
if ( !fragmentDocument )
{
markup( "\\date{" );
}
else
{
ignoreText = true;
}
}
/**
* {@inheritDoc}
*/
public void date_()
{
if ( !fragmentDocument )
{
markup( "}" + EOL );
}
else
{
ignoreText = false;
}
}
/** {@inheritDoc} */
public void sectionTitle( int level, SinkEventAttributes attributes )
{
isTitle = true;
}
/** {@inheritDoc} */
public void sectionTitle_( int level )
{
String command = "";
switch ( level )
{
case SECTION_LEVEL_1:
command = "section";
break;
case SECTION_LEVEL_2:
command = "subsection";
break;
case SECTION_LEVEL_3:
command = "subsubsection";
break;
case SECTION_LEVEL_4:
command = "paragraph";
break;
case SECTION_LEVEL_5:
command = "subparagraph";
break;
default:
throw new IllegalArgumentException( "Not a section level: " + level );
}
isTitle = false;
if ( StringUtils.isNotEmpty( title ) )
{
markup( EOL + "\\" + command + "{" + title + "}" + EOL );
title = null;
}
}
// ----------------------------------------------------------------------
// Section Title 1
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void sectionTitle1()
{
sectionTitle( SECTION_LEVEL_1, null );
}
/**
* {@inheritDoc}
*/
public void sectionTitle1_()
{
sectionTitle_( SECTION_LEVEL_1 );
}
// ----------------------------------------------------------------------
// Section Title 2
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void sectionTitle2()
{
sectionTitle( SECTION_LEVEL_2, null );
}
/**
* {@inheritDoc}
*/
public void sectionTitle2_()
{
sectionTitle_( SECTION_LEVEL_2 );
}
// ----------------------------------------------------------------------
// Section Title 3
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void sectionTitle3()
{
sectionTitle( SECTION_LEVEL_3, null );
}
/**
* {@inheritDoc}
*/
public void sectionTitle3_()
{
sectionTitle_( SECTION_LEVEL_3 );
}
// ----------------------------------------------------------------------
// Section Title 4
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void sectionTitle4()
{
sectionTitle( SECTION_LEVEL_4, null );
}
/**
* {@inheritDoc}
*/
public void sectionTitle4_()
{
sectionTitle_( SECTION_LEVEL_4 );
}
// ----------------------------------------------------------------------
// Section Title 5
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void sectionTitle5()
{
sectionTitle( SECTION_LEVEL_5, null );
}
/**
* {@inheritDoc}
*/
public void sectionTitle5_()
{
sectionTitle_( SECTION_LEVEL_5 );
}
// ----------------------------------------------------------------------
// List
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void list()
{
list( null );
}
/** {@inheritDoc} */
public void list( SinkEventAttributes attributes )
{
markup( EOL + "\\begin{itemize}" );
}
/**
* {@inheritDoc}
*/
public void list_()
{
markup( EOL + "\\end{itemize}" + EOL );
}
/**
* {@inheritDoc}
*/
public void listItem()
{
listItem( null );
}
/** {@inheritDoc} */
public void listItem( SinkEventAttributes attributes )
{
markup( EOL + "\\item " );
}
/**
* {@inheritDoc}
*/
public void numberedList( int numbering )
{
numberedList( numbering, null );
}
/** {@inheritDoc} */
public void numberedList( int numbering, SinkEventAttributes attributes )
{
++numberedListNesting;
String counter;
switch ( numberedListNesting )
{
case 1:
counter = "enumi";
break;
case 2:
counter = "enumii";
break;
case 3:
counter = "enumiii";
break;
case 4:
default:
counter = "enumiv";
}
String style;
switch ( numbering )
{
case NUMBERING_UPPER_ALPHA:
style = "Alph";
break;
case NUMBERING_LOWER_ALPHA:
style = "alph";
break;
case NUMBERING_UPPER_ROMAN:
style = "Roman";
break;
case NUMBERING_LOWER_ROMAN:
style = "roman";
break;
case NUMBERING_DECIMAL:
default:
style = "arabic";
}
markup( EOL + "\\begin{enumerate}" + EOL );
markup( "\\renewcommand{\\the" + counter + "}{\\" + style + "{" + counter + "}}" + EOL );
}
/**
* {@inheritDoc}
*/
public void numberedList_()
{
markup( EOL + "\\end{enumerate}" + EOL );
--numberedListNesting;
}
/**
* {@inheritDoc}
*/
public void numberedListItem()
{
numberedListItem( null );
}
/** {@inheritDoc} */
public void numberedListItem( SinkEventAttributes attributes )
{
markup( "\\item " );
}
/**
* {@inheritDoc}
*/
public void definitionList()
{
definitionList( null );
}
/** {@inheritDoc} */
public void definitionList( SinkEventAttributes attributes )
{
markup( EOL + "\\begin{description}" );
}
/**
* {@inheritDoc}
*/
public void definitionList_()
{
markup( EOL + "\\end{description}" + EOL );
}
/**
* {@inheritDoc}
*/
public void definedTerm()
{
definedTerm( null );
}
/** {@inheritDoc} */
public void definedTerm( SinkEventAttributes attributes )
{
markup( EOL + "\\item[\\mbox{" );
}
/**
* {@inheritDoc}
*/
public void definedTerm_()
{
markup( "}] " );
}
/** {@inheritDoc} */
public void definitionListItem()
{
definitionListItem( null );
}
/** {@inheritDoc} */
public void definitionListItem( SinkEventAttributes attributes )
{
// nop
}
/** {@inheritDoc} */
public void definitionListItem_()
{
// nop
}
/** {@inheritDoc} */
public void definition()
{
definition( null );
}
/** {@inheritDoc} */
public void definition( SinkEventAttributes attributes )
{
// nop
}
/** {@inheritDoc} */
public void definition_()
{
// nop
}
// ----------------------------------------------------------------------
// Figure
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void figure()
{
figure( null );
}
/** {@inheritDoc} */
public void figure( SinkEventAttributes attributes )
{
figureFlag = true;
markup( EOL + "\\begin{figure}[htb]" + EOL );
}
/**
* {@inheritDoc}
*/
public void figure_()
{
markup( "\\end{figure}" + EOL );
figureFlag = false;
}
/**
* {@inheritDoc}
*/
public void figureGraphics( String name )
{
figureGraphics( name, null );
}
/** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
if ( !src.toLowerCase( Locale.ENGLISH ).endsWith( ".eps" ) )
{
getLog().warn( "[Latex Sink] Found non-eps figure graphics!" );
}
markup( "\\begin{center}" + EOL );
markup( "\\includegraphics{" + src + "}" + EOL );
markup( "\\end{center}" + EOL );
}
/**
* {@inheritDoc}
*/
public void figureCaption()
{
figureCaption( null );
}
/** {@inheritDoc} */
public void figureCaption( SinkEventAttributes attributes )
{
markup( "\\caption{" );
}
/**
* {@inheritDoc}
*/
public void figureCaption_()
{
markup( "}" + EOL );
}
// ----------------------------------------------------------------------
// Table
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void table()
{
table( null );
}
/** {@inheritDoc} */
public void table( SinkEventAttributes attributes )
{
tableFlag = true;
markup( EOL + "\\begin{table}[htp]" + EOL );
}
/**
* {@inheritDoc}
*/
public void table_()
{
markup( "\\end{table}" + EOL );
tableFlag = false;
}
/**
* {@inheritDoc}
*/
public void tableRows( int[] justification, boolean grid )
{
StringBuffer justif = new StringBuffer();
for ( int i = 0; i < justification.length; ++i )
{
if ( grid )
{
justif.append( '|' );
}
switch ( justification[i] )
{
case Sink.JUSTIFY_CENTER:
justif.append( 'c' );
break;
case Sink.JUSTIFY_LEFT:
justif.append( 'l' );
break;
case Sink.JUSTIFY_RIGHT:
justif.append( 'r' );
break;
default:
break;
}
}
if ( grid )
{
justif.append( '|' );
}
markup( "\\begin{center}" + EOL );
markup( "\\begin{tabular}{" + justif.toString() + "}" + EOL );
if ( grid )
{
markup( "\\hline" + EOL );
}
gridFlag = grid;
cellJustif = justification;
}
/**
* {@inheritDoc}
*/
public void tableRows_()
{
markup( "\\end{tabular}" + EOL );
markup( "\\end{center}" + EOL );
gridFlag = false;
cellJustif = null;
}
/**
* {@inheritDoc}
*/
public void tableRow()
{
tableRow( null );
}
/** {@inheritDoc} */
public void tableRow( SinkEventAttributes attributes )
{
cellCount = 0;
}
/**
* {@inheritDoc}
*/
public void tableRow_()
{
markup( "\\\\" + EOL );
if ( gridFlag || lastCellWasHeader )
{
markup( "\\hline" + EOL );
}
cellCount = 0;
lastCellWasHeader = false;
}
/**
* {@inheritDoc}
*/
public void tableCell()
{
tableCell( (SinkEventAttributes) null );
}
/** {@inheritDoc} */
public void tableCell( String width )
{
SinkEventAttributeSet att = new SinkEventAttributeSet();
att.addAttribute( javax.swing.text.html.HTML.Attribute.WIDTH, width );
tableCell( att );
}
/** {@inheritDoc} */
public void tableCell( SinkEventAttributes attributes )
{
tableCell( false );
}
/**
* {@inheritDoc}
*/
public void tableCell_()
{
markup( "\\end{tabular}" );
++cellCount;
}
/**
* {@inheritDoc}
*/
public void tableHeaderCell()
{
tableCell( (SinkEventAttributes) null );
}
/** {@inheritDoc} */
public void tableHeaderCell( String width )
{
SinkEventAttributeSet att = new SinkEventAttributeSet();
att.addAttribute( javax.swing.text.html.HTML.Attribute.WIDTH, width );
tableHeaderCell( att );
}
/** {@inheritDoc} */
public void tableHeaderCell( SinkEventAttributes attributes )
{
tableCell( true );
}
/**
* {@inheritDoc}
*/
public void tableHeaderCell_()
{
tableCell_();
}
private boolean lastCellWasHeader = false;
/**
* Starts a table cell.
*
* @param header True if this is a header cell.
*/
private void tableCell( boolean header )
{
lastCellWasHeader = header;
if ( cellCount > 0 )
{
markup( " &" + EOL );
}
char justif;
switch ( cellJustif[cellCount] )
{
case Sink.JUSTIFY_LEFT:
justif = 'l';
break;
case Sink.JUSTIFY_RIGHT:
justif = 'r';
break;
case Sink.JUSTIFY_CENTER:
default:
justif = 'c';
break;
}
markup( "\\begin{tabular}[t]{" + justif + "}" );
}
/**
* {@inheritDoc}
*/
public void tableCaption()
{
tableCaption( null );
}
/** {@inheritDoc} */
public void tableCaption( SinkEventAttributes attributes )
{
markup( "\\caption{" );
}
/**
* {@inheritDoc}
*/
public void tableCaption_()
{
markup( "}" + EOL );
}
/**
* {@inheritDoc}
*/
public void paragraph()
{
paragraph( null );
}
/** {@inheritDoc} */
public void paragraph( SinkEventAttributes attributes )
{
markup( EOL + EOL );
}
/**
* {@inheritDoc}
*/
public void paragraph_()
{
markup( EOL );
}
/**
* {@inheritDoc}
*/
public void verbatim( boolean boxed )
{
verbatim( boxed ? SinkEventAttributeSet.BOXED : null );
}
/** {@inheritDoc} */
public void verbatim( SinkEventAttributes attributes )
{
boolean boxed = false;
if ( attributes != null && attributes.isDefined( SinkEventAttributes.DECORATION ) )
{
boxed = "boxed".equals(
attributes.getAttribute( SinkEventAttributes.DECORATION ) );
}
markup( EOL + "\\begin{small}" + EOL );
if ( boxed )
{
markup( "\\begin{Verbatim}[frame=single]" + EOL );
}
else
{
markup( "\\begin{Verbatim}" + EOL );
}
verbatimFlag = true;
}
/**
* {@inheritDoc}
*/
public void verbatim_()
{
markup( EOL + "\\end{Verbatim}" + EOL );
markup( "\\end{small}" + EOL );
verbatimFlag = false;
}
/**
* {@inheritDoc}
*/
public void horizontalRule()
{
horizontalRule( null );
}
/** {@inheritDoc} */
public void horizontalRule( SinkEventAttributes attributes )
{
markup( EOL + "\\begin{center}\\rule[0.5ex]{\\linewidth}{1pt}\\end{center}" + EOL );
}
/**
* {@inheritDoc}
*/
public void pageBreak()
{
markup( EOL + "\\newpage" + EOL );
}
/**
* {@inheritDoc}
*/
public void anchor( String name )
{
anchor( name, null );
}
/** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
markup( "\\hypertarget{" + name + "}{" );
}
/**
* {@inheritDoc}
*/
public void anchor_()
{
markup( "}" );
}
/**
* {@inheritDoc}
*/
public void link( String name )
{
link( name, null );
}
/** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
// TODO: use \\url for simple links
if ( DoxiaUtils.isExternalLink( name ) )
{
markup( "\\href{" + name + "}{" );
}
else
{
markup( "\\hyperlink{" + name + "}{" );
}
}
/**
* {@inheritDoc}
*/
public void link_()
{
markup( "}" );
}
/**
* {@inheritDoc}
*/
public void italic()
{
markup( "\\textit{" );
}
/**
* {@inheritDoc}
*/
public void italic_()
{
markup( "}" );
}
/**
* {@inheritDoc}
*/
public void bold()
{
markup( "\\textbf{" );
}
/**
* {@inheritDoc}
*/
public void bold_()
{
markup( "}" );
}
/**
* {@inheritDoc}
*/
public void monospaced()
{
markup( "\\texttt{\\small " );
}
/**
* {@inheritDoc}
*/
public void monospaced_()
{
markup( "}" );
}
/**
* {@inheritDoc}
*/
public void lineBreak()
{
lineBreak( null );
}
/** {@inheritDoc} */
public void lineBreak( SinkEventAttributes attributes )
{
markup( ( figureFlag || tableFlag || titleFlag || verbatimFlag ) ? EOL : "\\newline" + EOL );
}
/**
* {@inheritDoc}
*/
public void nonBreakingSpace()
{
markup( "~" );
}
/**
* {@inheritDoc}
*/
public void text( String text )
{
text( text, null );
}
/** {@inheritDoc} */
public void text( String text, SinkEventAttributes attributes )
{
if ( ignoreText )
{
return;
}
if ( isTitle )
{
title = text;
}
else if ( verbatimFlag )
{
verbatimContent( text );
}
else
{
content( text );
}
}
/** {@inheritDoc} */
public void rawText( String text )
{
verbatimContent( text );
}
/** {@inheritDoc} */
public void comment( String comment )
{
rawText( EOL + "% " + comment );
}
/**
* {@inheritDoc}
*
* Unkown events just log a warning message but are ignored otherwise.
* @see org.apache.maven.doxia.sink.Sink#unknown(String,Object[],SinkEventAttributes)
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
getLog().warn( "[Latex Sink] Unknown Sink event: '" + name + "', ignoring!" );
}
// -----------------------------------------------------------------------
/**
* Writes the text, preserving whitespace.
*
* @param text the text to write.
*/
protected void markup( String text )
{
if ( text != null )
{
out.write( text, /*preserveSpace*/ true );
}
}
/**
* Writes the text, without preserving whitespace.
*
* @param text the text to write.
*/
protected void content( String text )
{
out.write( escaped( text ), /*preserveSpace*/ false );
}
/**
* Writes the text, preserving whitespace.
*
* @param text the text to write.
*/
protected void verbatimContent( String text )
{
out.write( text, /*preserveSpace*/ true );
}
// -----------------------------------------------------------------------
/**
* Escapes special characters.
*
* @param text The text to escape.
* @return The text with special characters replaced.
*/
public static String escaped( String text )
{
int length = text.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = text.charAt( i );
switch ( c )
{
case '-':
case '<':
case '>':
buffer.append( "\\symbol{" ).append( (int) c ).append( "}" );
break;
case '~':
buffer.append( "\\textasciitilde " );
break;
case '^':
buffer.append( "\\textasciicircum " );
break;
case '|':
buffer.append( "\\textbar " );
break;
case '\\':
buffer.append( "\\textbackslash " );
break;
case '$':
buffer.append( "\\$" );
break;
case '&':
buffer.append( "\\&" );
break;
case '%':
buffer.append( "\\%" );
break;
case '#':
buffer.append( "\\#" );
break;
case '{':
buffer.append( "\\{" );
break;
case '}':
buffer.append( "\\}" );
break;
case '_':
buffer.append( "\\_" );
break;
default:
buffer.append( c );
}
}
return buffer.toString();
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*/
public void flush()
{
out.flush();
}
/**
* {@inheritDoc}
*/
public void close()
{
out.close();
init();
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* Returns the default sink commands from a resource.
*
* @throws java.io.IOException if the resource file cannot be read.
* @return InputStream
*/
private static InputStream getDefaultSinkCommands()
throws IOException
{
return LatexSink.class.getResource( "default_sink_commands.tex" ).openStream();
}
/**
* Returns the default preamble from a resource.
*
* @return InputStream
* @throws java.io.IOException if the resource file cannot be read.
*/
private static InputStream getDefaultPreamble()
throws IOException
{
return LatexSink.class.getResource( "default_preamble.tex" ).openStream();
}
/**
* Returns the default sink commands.
*
* @return String.
*/
protected String defaultSinkCommands()
{
try
{
return IOUtil.toString( getDefaultSinkCommands() );
}
catch ( IOException ioe )
{
// this should not happen
getLog().warn( "Could not read default LaTeX commands, the generated LaTeX file will not compile!" );
getLog().debug( ioe );
return "";
}
}
/**
* Returns the default preamble.
*
* @return String.
*/
protected String defaultPreamble()
{
try
{
return IOUtil.toString( getDefaultPreamble() );
}
catch ( IOException ioe )
{
// this should not happen
getLog().warn( "Could not read default LaTeX preamble, the generated LaTeX file will not compile!" );
getLog().debug( ioe );
return "";
}
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.ignoreText = false;
this.titleFlag = false;
this.numberedListNesting = 0;
this.verbatimFlag = false;
this.figureFlag = false;
this.tableFlag = false;
this.gridFlag = false;
this.cellJustif = null;
this.cellCount = 0;
this.isTitle = false;
this.title = null;
}
}
doxia-1.1.4/doxia-modules/doxia-module-apt/ 0000755 0001750 0001750 00000000000 11632765557 020523 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/pom.xml 0000644 0001750 0001750 00000004347 11470562366 022041 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia-modules</artifactId>
<groupId>org.apache.maven.doxia</groupId>
<version>1.1.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>doxia-module-apt</artifactId>
<name>Doxia :: APT Module</name>
<description>A Doxia module for Almost Plain Text source documents.</description>
<!-- START SNIPPET: test -->
<!-- test snippet -->
<!-- END SNIPPET: test -->
<dependencies>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-maven-plugin</artifactId>
<configuration>
<descriptors>
<descriptor>src/main/components/components.xml</descriptor>
<descriptor>target/generated-resources/plexus/META-INF/plexus/components.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<goals>
<goal>merge-descriptors</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
</project> doxia-1.1.4/doxia-modules/doxia-module-apt/src/ 0000755 0001750 0001750 00000000000 11632765557 021312 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/ 0000755 0001750 0001750 00000000000 11632765557 022271 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765557 024303 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test/ 0000755 0001750 0001750 00000000000 11632765557 025262 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test/macro.apt 0000644 0001750 0001750 00000000311 11123451532 027040 0 ustar twerner twerner -----
Test DOXIA-77
-----
Vincent Siveton
-----
Test DOXIA-77
%{snippet|id=superpom|url=http://svn.apache.org/repos/asf/maven/doxia/doxia/trunk/doxia-test-docs/src/main/resources/pom-4.0.0.xml}
doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test/snippet.apt 0000644 0001750 0001750 00000000214 11147213565 027433 0 ustar twerner twerner
* list item 1
%{snippet|id=test|file=pom.xml}
list paragraph text
* list item 2
+--
Verbatim text
+--
list paragraph text
doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test/linebreak.apt 0000644 0001750 0001750 00000000124 10577144430 027705 0 ustar twerner twerner -----
Test DOXIA-76
-----
Vincent Siveton
-----
Test DOXIA-76
Line\
break.
doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test/comments.apt 0000644 0001750 0001750 00000000203 11331346664 027576 0 ustar twerner twerner ~~ comments before title
~~ like a license header, for example
-----
Test DOXIA-379
-----
Herve Boutemy
-----
Test DOXIA-379
doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test/toc.apt 0000644 0001750 0001750 00000001162 11200764240 026530 0 ustar twerner twerner ----
Test DOXIA-40
-----
Vincent Siveton
-----
January 2007
-----
Test DOXIA-40
Section 1
%{toc|section=2|fromDepth=2|toDepth=4}
* {SubSection 1.1}
SubSection 1.1
** {Sub-SubSection 1.1.1}
SubSection 1.1.1
** {Sub-SubSection 1.1.2}
SubSection 1.1.2
*** {Sub-Sub-SubSection 1.1.2.1}
Sub-Sub-SubSection 1.1.2.1
**** {Sub-Sub-Sub-SubSection 1.1.2.1.1}
Sub-Sub-Sub-SubSection 1.1.2.1.1
*** {SubSub-SubSection 1.1.2.2}
SubSub-SubSection 1.1.2.2
* {SubSection 1.2}
SubSection 1.2
* {SubSection 1.3}
SubSection 1.3
* {SubSection 1.4}
SubSection 1.4
Section 2
* {SubSection 2.1}
SubSection 2.1 doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/resources/test.apt 0000644 0001750 0001750 00000004445 10651743017 025762 0 ustar twerner twerner ------
Title
------
Author
------
Date
Paragraph 1, line 1.
Paragraph 1, line 2.
Paragraph 2, line 1.
Paragraph 2, line 2.
Section title
* Sub-section title
** Sub-sub-section title
*** Sub-sub-sub-section title
**** Sub-sub-sub-sub-section title
* List item 1.
* List item 2.
Paragraph contained in list item 2.
* Sub-list item 1.
* Sub-list item 2.
* List item 3.
Force end of list:
[]
+------------------------------------------+
Verbatim text not contained in list item 3
+------------------------------------------+
[[1]] Numbered item 1.
[[A]] Numbered item A.
[[B]] Numbered item B.
[[2]] Numbered item 2.
List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]].
[Defined term 1] of definition list.
[Defined term 2] of definition list.
+-------------------------------+
Verbatim text
in a box
+-------------------------------+
--- instead of +-- suppresses the box around verbatim text.
[figure] Figure caption
*----------*--------------+----------------:
| Centered | Left-aligned | Right-aligned |
| cell 1,1 | cell 1,2 | cell 1,3 |
*----------*--------------+----------------:
| cell 2,1 | cell 2,2 | cell 2,3 |
*----------*--------------+----------------:
Table caption
No grid, no caption:
*-----*------*
cell | cell
*-----*------*
cell | cell
*-----*------*
*---------*---------*
|| header || header |
*---------*---------*
| cell | cell |
*---------*---------*
Horizontal line:
=======================================================================
New page.
<Italic> font. <<Bold>> font. <<<Monospaced>>> font.
{Anchor}. Link to {{Anchor}}. Link to {{http://www.pixware.fr}}.
Link to {{{Anchor}showing alternate text}}.
Link to {{{http://www.pixware.fr}Pixware home page}}.
Force line\
break.
Non\ breaking\ space.
Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.
Copyright symbol: \251, \xA9, \u00a9.
~~Commented out.
doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/ 0000755 0001750 0001750 00000000000 11632765557 023212 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765557 024001 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 025222 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 026330 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 027434 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 030721 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/ 0000755 0001750 0001750 00000000000 11632765557 031505 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000155 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsTest.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptUtilsT0000644 0001750 0001750 00000012624 11166637754 033325 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import junit.framework.TestCase;
/**
* Test AptUtils.
*
* @author ltheussl
* @version $Id: AptUtilsTest.java 762718 2009-04-07 11:58:36Z ltheussl $
*/
public class AptUtilsTest
extends TestCase
{
/**
* Test of isExternalLink method, of class AptUtils.
*/
public void testIsExternalLink()
{
String link = "http://maven.apache.org/";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "https://maven.apache.org/";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "HTTPS://MAVEN.APACHE.ORG/";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "ftp:/maven.apache.org/";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "mailto:maven@apache.org";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "file:/index.html";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "resource_type://domain:port/filepathname?query_string#anchor";
assertTrue( "Should be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "index.html";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "example.pdf";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "./index.html";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "../index.html";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
// Windows style separators "\" are not allowed
link = "file:\\index.html";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = ".\\index.html";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
link = "..\\index.html";
assertFalse( "Should NOT be an external link: " + link,
AptUtils.isExternalLink( link ) );
}
/**
* Test of isInternalLink method, of class AptUtils.
*/
public void testIsInternalLink()
{
String link = "index.html";
assertTrue( "Should be an internal link: " + link, AptUtils.isInternalLink( link ) );
link = "file:/index.html";
assertFalse( "Should NOT be an internal link: " + link, AptUtils.isInternalLink( link ) );
link = "./index.html";
assertFalse( "Should NOT be an internal link: " + link, AptUtils.isInternalLink( link ) );
}
/**
* Test of isLocalLink method, of class AptUtils.
*/
public void testIsLocalLink()
{
String link = "/index.html";
assertTrue( "Should be a local link: " + link, AptUtils.isLocalLink( link ) );
link = "./index.html";
assertTrue( "Should be a local link: " + link, AptUtils.isLocalLink( link ) );
link = "../index.html";
assertTrue( "Should be a local link: " + link, AptUtils.isLocalLink( link ) );
link = "index.html";
assertFalse( "Should NOT be a local link: " + link, AptUtils.isLocalLink( link ) );
link = ".\\index.html";
assertFalse( "Should NOT be a local link: " + link, AptUtils.isLocalLink( link ) );
link = "\\index.html";
assertFalse( "Should NOT be a local link: " + link, AptUtils.isLocalLink( link ) );
link = "..\\index.html";
assertFalse( "Should NOT be a local link: " + link, AptUtils.isLocalLink( link ) );
}
/**
* Test of encodeAnchor method, of class AptUtils.
*/
public void testEncodeAnchor()
{
assertNull( AptUtils.encodeAnchor( null ) );
assertEquals( "a123_:_.-aBc", AptUtils.encodeAnchor( " 12!3 :_.&-a)Bc " ) );
}
/**
* Test of encodeFragment method, of class AptUtils.
*/
public void testEncodeFragment()
{
assertNull( AptUtils.encodeFragment( null ) );
assertEquals( "abc0d", AptUtils.encodeFragment( "a B&c0)D" ) );
}
/**
* Test of linkToKey method, of class AptUtils.
*/
public void testLinkToKey()
{
assertEquals( "abc56au", AptUtils.linkToKey( "aB$%C56 a&\\/'U" ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParserTest.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptParser0000644 0001750 0001750 00000064356 11331346664 033335 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.Reader;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Iterator;
import org.apache.maven.doxia.parser.AbstractParserTest;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
import org.codehaus.plexus.util.IOUtil;
/**
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: AptParserTest.java 905092 2010-01-31 18:36:36Z hboutemy $
*/
public class AptParserTest
extends AbstractParserTest
{
private AptParser parser;
/** {@inheritDoc} */
protected void setUp()
throws Exception
{
super.setUp();
parser = (AptParser) lookup( Parser.ROLE, "apt" );
}
/** {@inheritDoc} */
protected Parser createParser()
{
return parser;
}
protected String parseFileToAptSink( String file )
throws ParseException
{
StringWriter output = null;
Reader reader = null;
try
{
output = new StringWriter();
reader = getTestReader( file );
Sink sink = new AptSink( output );
createParser().parse( reader, sink );
}
finally
{
IOUtil.close( output );
IOUtil.close( reader );
}
return output.toString();
}
/** @throws Exception */
public void testLineBreak()
throws Exception
{
String linebreak = parseFileToAptSink( "test/linebreak" );
assertTrue( linebreak.indexOf( "Line\\" + EOL + "break." ) != -1 );
}
/** @throws Exception */
public void testSnippetMacro()
throws Exception
{
String macro = parseFileToAptSink( "test/macro" );
assertTrue( macro.indexOf( "<modelVersion\\>4.0.0\\</modelVersion\\>" ) != -1 );
}
/** @throws Exception */
public void testCommentsBeforeTitle()
throws Exception
{
String comments = parseFileToAptSink( "test/comments" );
assertEquals( 0, comments.indexOf( "~~ comments before title" + EOL + "~~ like a license header, for example"
+ EOL + " -----" + EOL + " Test DOXIA-379" ) );
}
/** @throws Exception */
public void testSnippet()
throws Exception
{
// DOXIA-259
Reader reader = null;
SinkEventTestingSink sink = new SinkEventTestingSink();
try
{
reader = getTestReader( "test/snippet" );
createParser().parse( reader, sink );
}
finally
{
IOUtil.close( reader );
}
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "list", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "listItem", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "verbatim", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "verbatim_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "listItem_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "listItem", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "verbatim", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "verbatim_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "listItem_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "list_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testTocMacro()
throws Exception
{
String toc = parseFileToAptSink( "test/toc" );
// No section, only subsection 1 and 2
assertTrue( toc.indexOf( "* {{{SubSection_1.1}SubSection 1.1}}" ) != -1 );
assertTrue( toc.indexOf( "* {{{SubSection_1.1.2.1.1}SubSection 1.1.2.1.1}}" ) == -1 );
}
/**
* Parses the test document test.apt and re-emits
* it into parser/test.apt.
*
* @throws java.io.IOException if the test file cannot be read.
* @throws org.apache.maven.doxia.parser.ParseException if the test file cannot be parsed.
*/
public void testTestDocument()
throws IOException, ParseException
{
Writer writer = null;
Reader reader = null;
try
{
writer = getTestWriter( "test" );
reader = getTestReader( "test" );
Sink sink = new AptSink( writer );
createParser().parse( reader, sink );
}
finally
{
IOUtil.close( writer );
IOUtil.close( reader );
}
}
/** @throws Exception */
public void testBoxedVerbatim()
throws Exception
{
String text = "+--" + EOL + "boxed verbatim" + EOL + "+--" + EOL
+ "---" + EOL + "un-boxed verbatim" + EOL + "---" + EOL;
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
SinkEventElement element = (SinkEventElement) it.next();
assertEquals( "verbatim", element.getName() );
Object[] args = element.getArgs();
assertEquals( SinkEventAttributeSet.BOXED, args[0] );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "verbatim_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "verbatim", element.getName() );
args = element.getArgs();
assertNull( args[0] );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "verbatim_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testMultiLinesInTableCells()
throws Exception
{
String text = "*----------*--------------+----------------:" + EOL +
" cell 1, | cell 1,2 | cell 1,3" + EOL +
" 1 | | " + EOL +
"*----------*--------------+----------------:" + EOL +
" cell 2,1 | cell 2, | cell 2,3" + EOL +
" | 2 |" + EOL +
"*----------*--------------+----------------:" + EOL +
" cell 3,1 | cell 3,2 | cell 3," + EOL +
" | | 3" + EOL +
"*----------*--------------+----------------:" + EOL;
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
SinkEventElement element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 1, 1", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 1,2", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 1,3", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 2,1", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 2, 2", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 2,3", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 3,1", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 3,2", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 3, 3", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testLineBreakInTableCells()
throws Exception
{
String text = "*----------*--------------+----------------:" + EOL +
" cell 1,\\ | cell 1,2 | cell 1,3" + EOL +
" 1 | | " + EOL +
"*----------*--------------+----------------:" + EOL +
" cell 2,1 | cell 2,\\ | cell 2,3" + EOL +
" | 2 |" + EOL +
"*----------*--------------+----------------:" + EOL +
" cell 3,1 | cell 3,2 | cell 3,\\" + EOL +
" | | 3" + EOL +
"*----------*--------------+----------------:" + EOL;
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
SinkEventElement element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 1,\u00A0", element.getArgs()[0] );
assertEquals( "lineBreak", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "1", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 1,2", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 1,3", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 2,1", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 2,\u00A0", element.getArgs()[0] );
assertEquals( "lineBreak", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "2", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 2,3", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 3,1", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 3,2", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "cell 3,\u00A0", element.getArgs()[0] );
assertEquals( "lineBreak", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "text", element.getName() );
assertNotNull( element.getArgs()[0] );
assertEquals( "3", element.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testDOXIA38()
throws Exception
{
String text =
"*----------*--------------*---------------*" + EOL +
"| Centered | Centered | Centered |" + EOL +
"*----------*--------------+---------------:" + EOL +
"| Centered | Left-aligned | Right-aligned |" + EOL +
"*----------*--------------+---------------:";
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
SinkEventElement event = (SinkEventElement) it.next();
assertEquals( "tableCell", event.getName() );
SinkEventAttributeSet atts = (SinkEventAttributeSet) event.getArgs()[0];
assertEquals( "center", atts.getAttribute( SinkEventAttributeSet.ALIGN ) );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertNotNull( event.getArgs()[0] );
assertEquals( "Centered", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "tableCell", event.getName() );
atts = (SinkEventAttributeSet) event.getArgs()[0];
assertEquals( "center", atts.getAttribute( SinkEventAttributeSet.ALIGN ) );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertNotNull( event.getArgs()[0] );
assertEquals( "Centered", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "tableCell", event.getName() );
atts = (SinkEventAttributeSet) event.getArgs()[0];
assertEquals( "center", atts.getAttribute( SinkEventAttributeSet.ALIGN ) );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertNotNull( event.getArgs()[0] );
assertEquals( "Centered", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "tableCell", event.getName() );
atts = (SinkEventAttributeSet) event.getArgs()[0];
assertEquals( "center", atts.getAttribute( SinkEventAttributeSet.ALIGN ) );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertNotNull( event.getArgs()[0] );
assertEquals( "Centered", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "tableCell", event.getName() );
atts = (SinkEventAttributeSet) event.getArgs()[0];
assertEquals( "left", atts.getAttribute( SinkEventAttributeSet.ALIGN ) );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertNotNull( event.getArgs()[0] );
assertEquals( "Left-aligned", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "tableCell", event.getName() );
atts = (SinkEventAttributeSet) event.getArgs()[0];
assertEquals( "right", atts.getAttribute( SinkEventAttributeSet.ALIGN ) );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertNotNull( event.getArgs()[0] );
assertEquals( "Right-aligned", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testSpecialCharactersInTables()
throws Exception
{
// DOXIA-323
String text =
" \\~ \\= \\- \\+ \\* \\[ \\] \\< \\> \\{ \\} \\\\" + EOL
+ EOL
+ "*--------------------------------------------------+---------------+" + EOL
+ "| \\~ \\= \\- \\+ \\* \\[ \\] \\< \\> \\{ \\} \\\\ | special chars |" + EOL
+ "*--------------------------------------------------+---------------+";
SinkEventTestingSink sink = new SinkEventTestingSink();
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "head", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "head_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "body", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
SinkEventElement event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertEquals( "~ = - + * [ ] < > { } \\", event.getArgs()[0] );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "table", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRows", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableRow", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertEquals( "~ = - + * [ ] < > { } \\", event.getArgs()[0] );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "text", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "tableCell_", ( (SinkEventElement) it.next() ).getName() );
}
/** {@inheritDoc} */
protected String outputExtension()
{
return "apt";
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptIdentityTest.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptIdenti0000644 0001750 0001750 00000002671 10767707462 033316 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.module.AbstractIdentityTest;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
/**
* Check that piping a full model through an AptParser and an AptSink
* leaves the model unchanged. The test is done in AbstractIdentityTest.
*/
public class AptIdentityTest extends AbstractIdentityTest
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new AptSink( writer );
}
/** {@inheritDoc} */
protected Parser createParser()
{
return new AptParser();
}
}
././@LongLink 0000000 0000000 0000000 00000000154 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTest.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/test/java/org/apache/maven/doxia/module/apt/AptSinkTe0000644 0001750 0001750 00000020666 11331346664 033272 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.markup.Markup;
import org.apache.maven.doxia.sink.AbstractSinkTest;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
/**
* Test the <code>AptSink</code> class
*
* @see AptSink
*/
public class AptSinkTest extends AbstractSinkTest
{
/** {@inheritDoc} */
protected String outputExtension()
{
return "apt";
}
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new AptSink( writer );
}
/** {@inheritDoc} */
protected boolean isXmlSink()
{
return false;
}
/** {@inheritDoc} */
protected String getTitleBlock( String title )
{
return title;
}
/** {@inheritDoc} */
protected String getAuthorBlock( String author )
{
return author;
}
/** {@inheritDoc} */
protected String getDateBlock( String date )
{
return date;
}
/** {@inheritDoc} */
protected String getHeadBlock()
{
return AptMarkup.HEADER_START_MARKUP + EOL + AptMarkup.HEADER_START_MARKUP + EOL + AptMarkup.HEADER_START_MARKUP
+ EOL + AptMarkup.HEADER_START_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getBodyBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getSectionTitleBlock( String title )
{
return title;
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return EOL + title + EOL + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return EOL + AptMarkup.SECTION_TITLE_START_MARKUP + title + EOL + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection3Block( String title )
{
return EOL + StringUtils.repeat( String.valueOf( AptMarkup.SECTION_TITLE_START_MARKUP ), 2 )
+ title + EOL + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection4Block( String title )
{
return EOL + StringUtils.repeat( String.valueOf( AptMarkup.SECTION_TITLE_START_MARKUP ), 3 )
+ title + EOL + EOL + EOL;
}
/** {@inheritDoc} */
protected String getSection5Block( String title )
{
return EOL + StringUtils.repeat( String.valueOf( AptMarkup.SECTION_TITLE_START_MARKUP ), 4 )
+ title + EOL + EOL + EOL;
}
/** {@inheritDoc} */
protected String getListBlock( String item )
{
return EOL + EOL + Markup.SPACE + "" + AptMarkup.LIST_START_MARKUP + "" + Markup.SPACE + item + EOL + EOL
+ Markup.SPACE + "" + AptMarkup.LIST_END_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getNumberedListBlock( String item )
{
return EOL + EOL + Markup.SPACE + "" + Markup.LEFT_SQUARE_BRACKET + ""
+ Markup.LEFT_SQUARE_BRACKET + AptMarkup.NUMBERING_LOWER_ROMAN_CHAR + ""
+ Markup.RIGHT_SQUARE_BRACKET + "" + Markup.RIGHT_SQUARE_BRACKET
+ Markup.SPACE + item + EOL + EOL + Markup.SPACE + "" + AptMarkup.LIST_END_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getDefinitionListBlock( String definum, String definition )
{
return EOL + EOL + Markup.SPACE + "" + Markup.LEFT_SQUARE_BRACKET + definum
+ Markup.RIGHT_SQUARE_BRACKET + "" + Markup.SPACE + definition + EOL + EOL
+ Markup.SPACE + "" + AptMarkup.LIST_END_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getFigureBlock( String source, String caption )
{
return EOL + Markup.LEFT_SQUARE_BRACKET + source + Markup.RIGHT_SQUARE_BRACKET
+ Markup.SPACE + caption + EOL;
}
/** {@inheritDoc} */
protected String getTableBlock( String cell, String caption )
{
return EOL + AptMarkup.TABLE_ROW_START_MARKUP + AptMarkup.TABLE_COL_CENTERED_ALIGNED_MARKUP + EOL + cell
+ AptMarkup.TABLE_ROW_SEPARATOR_MARKUP + EOL + AptMarkup.TABLE_ROW_START_MARKUP
+ AptMarkup.TABLE_COL_CENTERED_ALIGNED_MARKUP + EOL + caption + EOL;
}
/** {@inheritDoc} */
protected String getParagraphBlock( String text )
{
return EOL + Markup.SPACE + text + EOL + EOL;
}
/** {@inheritDoc} */
protected String getVerbatimBlock( String text )
{
return EOL + EOL + AptMarkup.BOXED_VERBATIM_START_MARKUP + EOL + text + EOL
+ AptMarkup.BOXED_VERBATIM_START_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return EOL + AptMarkup.HORIZONTAL_RULE_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getPageBreakBlock()
{
return EOL + AptMarkup.PAGE_BREAK_MARKUP + EOL;
}
/** {@inheritDoc} */
protected String getAnchorBlock( String anchor )
{
return AptMarkup.ANCHOR_START_MARKUP + anchor + AptMarkup.ANCHOR_END_MARKUP;
}
/** {@inheritDoc} */
protected String getLinkBlock( String link, String text )
{
String lnk = link.startsWith( "#" ) ? link.substring( 1 ) : link;
return AptMarkup.LINK_START_1_MARKUP + lnk + AptMarkup.LINK_START_2_MARKUP + text + AptMarkup.LINK_END_MARKUP;
}
/** {@inheritDoc} */
protected String getItalicBlock( String text )
{
return AptMarkup.ITALIC_START_MARKUP + text + AptMarkup.ITALIC_END_MARKUP;
}
/** {@inheritDoc} */
protected String getBoldBlock( String text )
{
return AptMarkup.BOLD_START_MARKUP + text + AptMarkup.BOLD_END_MARKUP;
}
/** {@inheritDoc} */
protected String getMonospacedBlock( String text )
{
return AptMarkup.MONOSPACED_START_MARKUP + text + AptMarkup.MONOSPACED_END_MARKUP;
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return String.valueOf( AptMarkup.BACKSLASH ) + EOL;
}
/** {@inheritDoc} */
protected String getNonBreakingSpaceBlock()
{
return AptMarkup.NON_BREAKING_SPACE_MARKUP;
}
/** {@inheritDoc} */
protected String getTextBlock( String text )
{
// "\\~, \\=, \\-, \\+, \\*, \\[, \\], \\<, \\>, \\{, \\}, \\\\"
StringBuffer sb = new StringBuffer();
sb.append( getSpecialCharacters( AptMarkup.COMMENT ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.EQUAL ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.MINUS ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.PLUS ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.STAR ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.LEFT_SQUARE_BRACKET ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.RIGHT_SQUARE_BRACKET ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.LESS_THAN ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.GREATER_THAN ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.LEFT_CURLY_BRACKET ) ).append( ",_" );
sb.append( getSpecialCharacters( Markup.RIGHT_CURLY_BRACKET ) ).append( ",_" );
sb.append( getSpecialCharacters( AptMarkup.BACKSLASH ) );
return sb.toString();
}
/** {@inheritDoc} */
protected String getRawTextBlock( String text )
{
return text;
}
/**
* Add a backslash for a special markup character
*
* @param c
* @return the character with a backslash before
*/
private static String getSpecialCharacters( char c )
{
return AptMarkup.BACKSLASH + "" + c;
}
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
return "~~ Simple comment with ----";
}
}
doxia-1.1.4/doxia-modules/doxia-module-apt/src/site/ 0000755 0001750 0001750 00000000000 11632765557 022256 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 023722 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
-->
<project>
<body>
<menu ref="parent"/>
<menu ref="reports"/>
</body>
</project> doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/ 0000755 0001750 0001750 00000000000 11632765557 022236 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/components/ 0000755 0001750 0001750 00000000000 11632765557 024423 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/components/components.xml 0000644 0001750 0001750 00000002476 11066147560 027330 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<component-set>
<components>
<component>
<role>org.apache.maven.doxia.parser.Parser</role>
<role-hint>apt</role-hint>
<implementation>org.apache.maven.doxia.module.apt.AptParser</implementation>
<description></description>
<requirements>
<requirement>
<role>org.apache.maven.doxia.macro.manager.MacroManager</role>
<field-name>macroManager</field-name>
</requirement>
</requirements>
</component>
</components>
</component-set>
doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/ 0000755 0001750 0001750 00000000000 11632765557 023157 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765557 023746 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 025167 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 026275 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 027401 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 030666 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/ 0000755 0001750 0001750 00000000000 11632765557 031452 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteModule.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSiteMo0000644 0001750 0001750 00000002546 11212745470 033233 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
* <p>AptSiteModule class.</p>
*
* @author <a href="mailto:jason@maven.org">Jason van Zyl</a>
* @version $Id: AptSiteModule.java 782392 2009-06-07 14:14:16Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="apt"
*/
public class AptSiteModule
extends AbstractSiteModule
{
/**
* Default constructor.
*/
public AptSiteModule()
{
super( "apt", "apt", "apt" );
}
}
././@LongLink 0000000 0000000 0000000 00000000151 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptUtils.0000644 0001750 0001750 00000014177 11151220275 033205 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.util.DoxiaUtils;
/**
* A collection of utility methods for dealing with APT documents.
*
* @author ltheussl
* @since 1.1
* @version $Id: AptUtils.java 747735 2009-02-25 10:43:09Z ltheussl $
*/
public class AptUtils
{
/**
* Replace all characters in a text.
*
* <pre>
* AptTools.encodeFragment( null ) = null
* AptTools.encodeFragment( "" ) = ""
* AptTools.encodeFragment( "http://www.google.com" ) = "httpwwwgooglecom"
* </pre>
*
* @param text the String to check, may be null.
* @return the text with only letter and digit, null if null String input.
* @deprecated This method was used for the original apt format, which
* removed all non alphanumeric characters from anchors.
* Use {@link #encodeAnchor(String)} instead.
*/
public static String encodeFragment( String text )
{
if ( text == null )
{
return null;
}
return linkToKey( text );
}
/**
* Checks if the given string corresponds to an external URI,
* ie is not a link within the same document nor a link to another
* document within the same site. This forwards to
* {@link org.apache.maven.doxia.util.DoxiaUtils#isExternalLink(String)}.
*
* @param link The link to check.
* @return True if DoxiaUtils.isExternalLink(link) returns true.
*
* @see org.apache.maven.doxia.util.DoxiaUtils#isExternalLink(String)
* @see #isInternalLink(String)
* @see #isLocalLink(String)
*/
public static boolean isExternalLink( String link )
{
return DoxiaUtils.isExternalLink( link );
}
/**
* Checks if the given string corresponds to an internal link,
* ie it is a link to an anchor within the same document.
*
* @param link The link to check.
* @return True if link is neither an {@link #isExternalLink(String) external}
* nor a {@link #isLocalLink(String) local} link.
*
* @see org.apache.maven.doxia.util.DoxiaUtils#isInternalLink(String)
* @see #isExternalLink(String)
* @see #isLocalLink(String)
*/
public static boolean isInternalLink( String link )
{
return ( !isExternalLink( link ) && !isLocalLink( link ) );
}
/**
* Checks if the given string corresponds to a relative link to another document
* within the same site.
*
* @param link The link to check.
* @return True if the link starts with either "/", "./" or "../".
*
* @see org.apache.maven.doxia.util.DoxiaUtils#isLocalLink(String)
* @see #isExternalLink(String)
* @see #isInternalLink(String)
*/
public static boolean isLocalLink( String link )
{
return ( link.startsWith( "/" ) || link.startsWith( "./" ) || link.startsWith( "../" ) );
}
/**
* Transforms the given text such that it can be used as a link.
* All non-LetterOrDigit characters are removed and the remaining
* characters are transformed to lower-case.
*
* @param text The text to transform.
* @return The text with all non-LetterOrDigit characters removed.
* @deprecated This method was used for the original apt format, which
* removed all non alphanumeric characters from anchors.
* Use {@link #encodeAnchor(String)} instead.
*/
public static String linkToKey( String text )
{
int length = text.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = text.charAt( i );
if ( Character.isLetterOrDigit( c ) )
{
buffer.append( Character.toLowerCase( c ) );
}
}
return buffer.toString();
}
/**
* Construct a valid anchor. This is a simplified version of
* {@link org.apache.maven.doxia.util.DoxiaUtils#encodeId(String)}
* to ensure the anchor is a valid Doxia id.
* The procedure is identical to the one in
* {@link org.apache.maven.doxia.util.HtmlTools#encodeId(String)}:
*
* <ol>
* <li> Trim the id</li>
* <li> If the first character is not a letter, prepend the letter 'a'</li>
* <li> Any space is replaced with an underscore '_'</li>
* <li> Remove any non alphanumeric characters except ':', '_', '.', '-'.</li>
* </ol>
*
* @param id The id to be encoded.
* @return The trimmed and encoded id, or null if id is null.
*/
public static String encodeAnchor( String id )
{
if ( id == null )
{
return null;
}
id = id.trim();
int length = id.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = id.charAt( i );
if ( ( i == 0 ) && ( !Character.isLetter( c ) ) )
{
buffer.append( 'a' );
}
if ( c == ' ' )
{
buffer.append( '_' );
}
else if ( ( Character.isLetterOrDigit( c ) ) || ( c == '-' ) || ( c == '_' ) || ( c == ':' )
|| ( c == '.' ) )
{
buffer.append( c );
}
}
return buffer.toString();
}
private AptUtils()
{
// utility class
}
}
././@LongLink 0000000 0000000 0000000 00000000157 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSinkFactory.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSinkFa0000644 0001750 0001750 00000003057 11105660512 033176 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractTextSinkFactory;
import org.apache.maven.doxia.sink.Sink;
/**
* APT implementation of the Sink factory.
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: AptSinkFactory.java 712574 2008-11-09 22:16:42Z hboutemy $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="apt"
*/
public class AptSinkFactory
extends AbstractTextSinkFactory
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding )
{
// encoding can safely be ignored since it isn't written into the generated APT source
return new AptSink( writer );
}
}
././@LongLink 0000000 0000000 0000000 00000000162 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParseException.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParseE0000644 0001750 0001750 00000007526 10767707462 033232 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.ParseException;
/**
* Wraps an exception when parsing apt source documents.
*
* @version $Id: AptParseException.java 638290 2008-03-18 09:45:22Z bentmann $
* @since 1.0
*/
public class AptParseException
extends ParseException
{
/** serialVersionUID */
static final long serialVersionUID = 1694654412921168623L;
/**
* Construct a new AptParseException with the specified detail message.
*
* @param message The detailed message.
* This can later be retrieved by the <code>Throwable.getMessage()</code> method.
*/
public AptParseException( String message )
{
super( message );
}
/**
* Construct a new AptParseException with the specified detail message and cause.
*
* @param message The detailed message.
* This can later be retrieved by the <code>Throwable.getMessage()</code> method.
* @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public AptParseException( String message, Exception e )
{
super( message, e );
}
/**
* Construct a new AptParseException with the specified cause, detail message,
* filename, line number and column number.
*
* @param message The detailed message.
* This can later be retrieved by the <code>Throwable.getMessage()</code> method.
* @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param name Name of a file that couldn't be parsed.
* This can later be retrieved by the getFileName() method.
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
*/
public AptParseException( String message, Exception e, String name, int line, int column )
{
super( e, message, name, line, column );
}
/**
* Construct a new AptParseException with the specified detail message and cause.
*
* @param message The detailed message.
* This can later be retrieved by the <code>Throwable.getMessage()</code> method.
* @param e the cause. This can be retrieved later by the <code>Throwable.getCause()</code> method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
*/
public AptParseException( String message, Exception e, int line, int column )
{
super( message, e, line, column );
}
}
././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSource0000644 0001750 0001750 00000003047 11150512716 033264 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* An interface to read apt source documents.
*
* @version $Id: AptSource.java 746982 2009-02-23 12:25:50Z vsiveton $
*/
public interface AptSource
{
/**
* Returns a line of the apt source document.
*
* @return a line of the apt source.
* @throws org.apache.maven.doxia.module.apt.AptParseException if the document can't be parsed.
*/
String getNextLine()
throws AptParseException;
/**
* Returns the name the apt source document.
*
* @return the name the apt source document.
*/
String getName();
/**
* Gets the current line number while parsing the document.
*
* @return the line number.
*/
int getLineNumber();
}
././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptParser0000644 0001750 0001750 00000255663 11375443016 033302 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.macro.manager.MacroNotFoundException;
import org.apache.maven.doxia.parser.AbstractTextParser;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkAdapter;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import java.io.IOException;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeSet;
/**
* The APT parser.
* <br/>
* Based on the <a href="http://www.xmlmind.com/aptconvert.html">APTconvert</a> project.
*
* @version $Id: AptParser.java 946932 2010-05-21 08:36:30Z ltheussl $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="apt"
*/
public class AptParser
extends AbstractTextParser
implements AptMarkup
{
/** Title event id */
private static final int TITLE = 0;
/** Section 1 event id */
private static final int SECTION1 = 1;
/** Section 2 event id */
private static final int SECTION2 = 2;
/** Section 3 event id */
private static final int SECTION3 = 3;
/** Section 4 event id */
private static final int SECTION4 = 4;
/** Section 5 event id */
private static final int SECTION5 = 5;
/** Paragraph event id */
private static final int PARAGRAPH = 6;
/** Verbatim event id */
private static final int VERBATIM = 7;
/** Figure event id */
private static final int FIGURE = 8;
/** Table event id */
private static final int TABLE = 9;
/** List event id */
private static final int LIST_ITEM = 10;
/** Numbered list event id */
private static final int NUMBERED_LIST_ITEM = 11;
/** Definition list event id */
private static final int DEFINITION_LIST_ITEM = 12;
/** Horizontal rule event id */
private static final int HORIZONTAL_RULE = 13;
/** Page break event id */
private static final int PG_BREAK = 14;
/** List break event id */
private static final int LIST_BREAK = 15;
/** Macro event id */
private static final int MACRO = 16;
/** Comment event id. */
private static final int COMMENT_BLOCK = 17;
/** String representations of event ids */
private static final String TYPE_NAMES[] = {
"TITLE",
"SECTION1",
"SECTION2",
"SECTION3",
"SECTION4",
"SECTION5",
"PARAGRAPH",
"VERBATIM",
"FIGURE",
"TABLE",
"LIST_ITEM",
"NUMBERED_LIST_ITEM",
"DEFINITION_LIST_ITEM",
"HORIZONTAL_RULE",
"PG_BREAK",
"LIST_BREAK",
"MACRO",
"COMMENT_BLOCK" };
/** An array of 85 spaces. */
protected static final char[] SPACES;
/** Default tab width. */
public static final int TAB_WIDTH = 8;
// ----------------------------------------------------------------------
// Instance fields
// ----------------------------------------------------------------------
/** the AptSource. */
private AptSource source;
/** a block of AptSource. */
private Block block;
/** blockFileName. */
private String blockFileName;
/** blockLineNumber. */
private int blockLineNumber;
/** sourceContent. */
protected String sourceContent;
/** the sink to receive the events. */
protected Sink sink;
/** a line of AptSource. */
protected String line;
/** Map of warn messages with a String as key to describe the error type and a Set as value.
* Using to reduce warn messages. */
protected Map warnMessages;
private static final int NUMBER_OF_SPACES = 85;
static
{
SPACES = new char[NUMBER_OF_SPACES];
for ( int i = 0; i < NUMBER_OF_SPACES; i++ )
{
SPACES[i] = ' ';
}
}
// ----------------------------------------------------------------------
// Public methods
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void parse( Reader source, Sink sink )
throws ParseException
{
init();
try
{
StringWriter contentWriter = new StringWriter();
IOUtil.copy( source, contentWriter );
sourceContent = contentWriter.toString();
}
catch ( IOException e )
{
throw new AptParseException( "IOException: " + e.getMessage(), e );
}
try
{
this.source = new AptReaderSource( new StringReader( sourceContent ) );
this.sink = sink;
sink.enableLogging( getLog() );
blockFileName = null;
blockLineNumber = -1;
// Lookahead line.
nextLine();
// Lookahead block.
nextBlock( /*first*/true );
// traverse comments
while ( ( block != null ) && ( block.getType() == COMMENT_BLOCK ) )
{
block.traverse();
nextBlock( /*first*/true );
}
traverseHead();
traverseBody();
}
catch ( AptParseException ape )
{
// TODO handle column number
throw new AptParseException( ape.getMessage(), ape, getSourceName(), getSourceLineNumber(), -1 );
}
finally
{
logWarnings();
setSecondParsing( false );
init();
}
}
/**
* Returns the name of the Apt source document.
*
* @return the source name.
*/
public String getSourceName()
{
// Use this rather than source.getName() to report errors.
return blockFileName;
}
/**
* Returns the current line number of the Apt source document.
*
* @return the line number.
*/
public int getSourceLineNumber()
{
// Use this rather than source.getLineNumber() to report errors.
return blockLineNumber;
}
// ----------------------------------------------------------------------
// Protected methods
// ----------------------------------------------------------------------
/**
* Parse the next line of the Apt source document.
*
* @throws org.apache.maven.doxia.module.apt.AptParseException if something goes wrong.
*/
protected void nextLine()
throws AptParseException
{
line = source.getNextLine();
}
/**
* Parse the given text.
*
* @param text the text to parse.
* @param begin offset.
* @param end offset.
* @param sink the sink to receive the events.
* @throws org.apache.maven.doxia.module.apt.AptParseException if something goes wrong.
*/
protected void doTraverseText( String text, int begin, int end, Sink sink )
throws AptParseException
{
boolean anchor = false;
boolean link = false;
boolean italic = false;
boolean bold = false;
boolean monospaced = false;
StringBuffer buffer = new StringBuffer( end - begin );
for ( int i = begin; i < end; ++i )
{
char c = text.charAt( i );
switch ( c )
{
case BACKSLASH:
if ( i + 1 < end )
{
char escaped = text.charAt( i + 1 );
switch ( escaped )
{
case SPACE:
++i;
flushTraversed( buffer, sink );
sink.nonBreakingSpace();
break;
case '\r':
case '\n':
++i;
// Skip white space which may follow a line break.
while ( i + 1 < end && Character.isWhitespace( text.charAt( i + 1 ) ) )
{
++i;
}
flushTraversed( buffer, sink );
sink.lineBreak();
break;
case BACKSLASH:
case PIPE:
case COMMENT:
case EQUAL:
case MINUS:
case PLUS:
case STAR:
case LEFT_SQUARE_BRACKET:
case RIGHT_SQUARE_BRACKET:
case LESS_THAN:
case GREATER_THAN:
case LEFT_CURLY_BRACKET:
case RIGHT_CURLY_BRACKET:
++i;
buffer.append( escaped );
break;
case 'x':
if ( i + 3 < end && isHexChar( text.charAt( i + 2 ) )
&& isHexChar( text.charAt( i + 3 ) ) )
{
int value = '?';
try
{
value = Integer.parseInt( text.substring( i + 2, i + 4 ), 16 );
}
catch ( NumberFormatException e )
{
if ( getLog().isDebugEnabled() )
{
getLog().debug( "Not a number: " + text.substring( i + 2, i + 4 ) );
}
}
i += 3;
buffer.append( (char) value );
}
else
{
buffer.append( BACKSLASH );
}
break;
case 'u':
if ( i + 5 < end && isHexChar( text.charAt( i + 2 ) )
&& isHexChar( text.charAt( i + 3 ) ) && isHexChar( text.charAt( i + 4 ) )
&& isHexChar( text.charAt( i + 5 ) ) )
{
int value = '?';
try
{
value = Integer.parseInt( text.substring( i + 2, i + 6 ), 16 );
}
catch ( NumberFormatException e )
{
if ( getLog().isDebugEnabled() )
{
getLog().debug( "Not a number: " + text.substring( i + 2, i + 6 ) );
}
}
i += 5;
buffer.append( (char) value );
}
else
{
buffer.append( BACKSLASH );
}
break;
default:
if ( isOctalChar( escaped ) )
{
int octalChars = 1;
if ( isOctalChar( charAt( text, end, i + 2 ) ) )
{
++octalChars;
if ( isOctalChar( charAt( text, end, i + 3 ) ) )
{
++octalChars;
}
}
int value = '?';
try
{
value = Integer.parseInt( text.substring( i + 1, i + 1 + octalChars ), 8 );
}
catch ( NumberFormatException e )
{
if ( getLog().isDebugEnabled() )
{
getLog().debug(
"Not a number: "
+ text.substring( i + 1, i + 1 + octalChars ) );
}
}
i += octalChars;
buffer.append( (char) value );
}
else
{
buffer.append( BACKSLASH );
}
}
}
else
{
buffer.append( BACKSLASH );
}
break;
case LEFT_CURLY_BRACKET: /*}*/
if ( !anchor && !link )
{
if ( i + 1 < end && text.charAt( i + 1 ) == LEFT_CURLY_BRACKET /*}*/ )
{
++i;
link = true;
flushTraversed( buffer, sink );
String linkAnchor = null;
if ( i + 1 < end && text.charAt( i + 1 ) == LEFT_CURLY_BRACKET /*}*/ )
{
++i;
StringBuffer buf = new StringBuffer();
i = skipTraversedLinkAnchor( text, i + 1, end, buf );
linkAnchor = buf.toString();
}
if ( linkAnchor == null )
{
linkAnchor = getTraversedLink( text, i + 1, end );
}
if ( AptUtils.isInternalLink( linkAnchor ) )
{
linkAnchor = "#" + linkAnchor;
}
int hashIndex = linkAnchor.indexOf( "#" );
if ( hashIndex != -1 && !AptUtils.isExternalLink( linkAnchor ) )
{
String hash = linkAnchor.substring( hashIndex + 1 );
if ( hash.endsWith( ".html" ) && !hash.startsWith( "./" ) )
{
String msg = "Ambiguous link: '" + hash
+ "'. If this is a local link, prepend \"./\"!";
logMessage( "ambiguousLink", msg );
}
if ( !DoxiaUtils.isValidId( hash ) )
{
linkAnchor =
linkAnchor.substring( 0, hashIndex ) + "#"
+ DoxiaUtils.encodeId( hash, true );
String msg = "Modified invalid link: '" + hash + "' to '" + linkAnchor + "'";
logMessage( "modifiedLink", msg );
}
}
sink.link( linkAnchor );
}
else
{
anchor = true;
flushTraversed( buffer, sink );
String linkAnchor = getTraversedAnchor( text, i + 1, end );
linkAnchor = AptUtils.encodeAnchor( linkAnchor );
sink.anchor( linkAnchor );
}
}
else
{
buffer.append( c );
}
break;
case /*{*/RIGHT_CURLY_BRACKET:
if ( link && i + 1 < end && text.charAt( i + 1 ) == /*{*/RIGHT_CURLY_BRACKET )
{
++i;
link = false;
flushTraversed( buffer, sink );
sink.link_();
}
else if ( anchor )
{
anchor = false;
flushTraversed( buffer, sink );
sink.anchor_();
}
else
{
buffer.append( c );
}
break;
case LESS_THAN:
if ( !italic && !bold && !monospaced )
{
if ( i + 1 < end && text.charAt( i + 1 ) == LESS_THAN )
{
if ( i + 2 < end && text.charAt( i + 2 ) == LESS_THAN )
{
i += 2;
monospaced = true;
flushTraversed( buffer, sink );
sink.monospaced();
}
else
{
++i;
bold = true;
flushTraversed( buffer, sink );
sink.bold();
}
}
else
{
italic = true;
flushTraversed( buffer, sink );
sink.italic();
}
}
else
{
buffer.append( c );
}
break;
case GREATER_THAN:
if ( monospaced && i + 2 < end && text.charAt( i + 1 ) == GREATER_THAN
&& text.charAt( i + 2 ) == GREATER_THAN )
{
i += 2;
monospaced = false;
flushTraversed( buffer, sink );
sink.monospaced_();
}
else if ( bold && i + 1 < end && text.charAt( i + 1 ) == GREATER_THAN )
{
++i;
bold = false;
flushTraversed( buffer, sink );
sink.bold_();
}
else if ( italic )
{
italic = false;
flushTraversed( buffer, sink );
sink.italic_();
}
else
{
buffer.append( c );
}
break;
default:
if ( Character.isWhitespace( c ) )
{
buffer.append( SPACE );
// Skip to the last char of a sequence of white spaces.
while ( i + 1 < end && Character.isWhitespace( text.charAt( i + 1 ) ) )
{
++i;
}
}
else
{
buffer.append( c );
}
}
}
if ( monospaced )
{
throw new AptParseException( "missing '" + MONOSPACED_END_MARKUP + "'" );
}
if ( bold )
{
throw new AptParseException( "missing '" + BOLD_END_MARKUP + "'" );
}
if ( italic )
{
throw new AptParseException( "missing '" + ITALIC_END_MARKUP + "'" );
}
if ( link )
{
throw new AptParseException( "missing '" + LINK_END_MARKUP + "'" );
}
if ( anchor )
{
throw new AptParseException( "missing '" + ANCHOR_END_MARKUP + "'" );
}
flushTraversed( buffer, sink );
}
// -----------------------------------------------------------------------
/**
* Returns the character at position i of the given string.
*
* @param string the string.
* @param length length.
* @param i offset.
* @return the character, or '\0' if i > length.
*/
protected static char charAt( String string, int length, int i )
{
return ( i < length ) ? string.charAt( i ) : '\0';
}
/**
* Skip spaces.
*
* @param string string.
* @param length length.
* @param i offset.
* @return int.
*/
protected static int skipSpace( String string, int length, int i )
{
loop: for ( ; i < length; ++i )
{
switch ( string.charAt( i ) )
{
case SPACE:
case TAB:
break;
default:
break loop;
}
}
return i;
}
/**
* Replace part of a string.
*
* @param string the string
* @param oldSub the substring to replace
* @param newSub the replacement string
* @return String
*/
protected static String replaceAll( String string, String oldSub, String newSub )
{
StringBuffer replaced = new StringBuffer();
int oldSubLength = oldSub.length();
int begin, end;
begin = 0;
while ( ( end = string.indexOf( oldSub, begin ) ) >= 0 )
{
if ( end > begin )
{
replaced.append( string.substring( begin, end ) );
}
replaced.append( newSub );
begin = end + oldSubLength;
}
if ( begin < string.length() )
{
replaced.append( string.substring( begin ) );
}
return replaced.toString();
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.sourceContent = null;
this.sink = null;
this.source = null;
this.block = null;
this.blockFileName = null;
this.blockLineNumber = 0;
this.line = null;
this.warnMessages = null;
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
/**
* Parse the head of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void traverseHead()
throws AptParseException
{
sink.head();
if ( block != null && block.getType() == TITLE )
{
block.traverse();
nextBlock();
}
sink.head_();
}
/**
* Parse the body of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void traverseBody()
throws AptParseException
{
sink.body();
if ( block != null )
{
traverseSectionBlocks();
}
while ( block != null )
{
traverseSection( 0 );
}
sink.body_();
}
/**
* Parse a section of the Apt source document.
*
* @param level The section level.
* @throws AptParseException if something goes wrong.
*/
private void traverseSection( int level )
throws AptParseException
{
if ( block == null )
{
return;
}
int type = SECTION1 + level;
expectedBlock( type );
switch ( level )
{
case 0:
sink.section1();
break;
case 1:
sink.section2();
break;
case 2:
sink.section3();
break;
case 3:
sink.section4();
break;
case 4:
sink.section5();
break;
default:
break;
}
block.traverse();
nextBlock();
traverseSectionBlocks();
while ( block != null )
{
if ( block.getType() <= type )
{
break;
}
traverseSection( level + 1 );
}
switch ( level )
{
case 0:
sink.section1_();
break;
case 1:
sink.section2_();
break;
case 2:
sink.section3_();
break;
case 3:
sink.section4_();
break;
case 4:
sink.section5_();
break;
default:
break;
}
}
/**
* Parse the section blocks of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void traverseSectionBlocks()
throws AptParseException
{
loop: while ( block != null )
{
switch ( block.getType() )
{
case PARAGRAPH:
case VERBATIM:
case FIGURE:
case TABLE:
case HORIZONTAL_RULE:
case PG_BREAK:
case MACRO:
case COMMENT_BLOCK:
block.traverse();
nextBlock();
break;
case LIST_ITEM:
traverseList();
break;
case NUMBERED_LIST_ITEM:
traverseNumberedList();
break;
case DEFINITION_LIST_ITEM:
traverseDefinitionList();
break;
case LIST_BREAK:
// May be this is a list break which has not been indented
// very precisely.
nextBlock();
break;
default:
// A section block which starts a new section.
break loop;
}
}
}
/**
* Parse a list of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void traverseList()
throws AptParseException
{
if ( block == null )
{
return;
}
expectedBlock( LIST_ITEM );
int listIndent = block.getIndent();
sink.list();
sink.listItem();
block.traverse();
nextBlock();
loop: while ( block != null )
{
int blockIndent = block.getIndent();
switch ( block.getType() )
{
case PARAGRAPH:
if ( blockIndent < listIndent )
{
break loop;
}
/*FALLTHROUGH*/
case VERBATIM:
case MACRO:
case FIGURE:
case TABLE:
case HORIZONTAL_RULE:
case PG_BREAK:
block.traverse();
nextBlock();
break;
case LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
if ( blockIndent > listIndent )
{
traverseList();
}
else
{
sink.listItem_();
sink.listItem();
block.traverse();
nextBlock();
}
break;
case NUMBERED_LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
traverseNumberedList();
break;
case DEFINITION_LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
traverseDefinitionList();
break;
case LIST_BREAK:
if ( blockIndent >= listIndent )
{
nextBlock();
}
/*FALLTHROUGH*/
default:
// A block which ends the list.
break loop;
}
}
sink.listItem_();
sink.list_();
}
/**
* Parse a numbered list of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void traverseNumberedList()
throws AptParseException
{
if ( block == null )
{
return;
}
expectedBlock( NUMBERED_LIST_ITEM );
int listIndent = block.getIndent();
sink.numberedList( ( (NumberedListItem) block ).getNumbering() );
sink.numberedListItem();
block.traverse();
nextBlock();
loop: while ( block != null )
{
int blockIndent = block.getIndent();
switch ( block.getType() )
{
case PARAGRAPH:
if ( blockIndent < listIndent )
{
break loop;
}
/*FALLTHROUGH*/
case VERBATIM:
case FIGURE:
case TABLE:
case HORIZONTAL_RULE:
case PG_BREAK:
block.traverse();
nextBlock();
break;
case LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
traverseList();
break;
case NUMBERED_LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
if ( blockIndent > listIndent )
{
traverseNumberedList();
}
else
{
sink.numberedListItem_();
sink.numberedListItem();
block.traverse();
nextBlock();
}
break;
case DEFINITION_LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
traverseDefinitionList();
break;
case LIST_BREAK:
if ( blockIndent >= listIndent )
{
nextBlock();
}
/*FALLTHROUGH*/
default:
// A block which ends the list.
break loop;
}
}
sink.numberedListItem_();
sink.numberedList_();
}
/**
* Parse a definition list of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void traverseDefinitionList()
throws AptParseException
{
if ( block == null )
{
return;
}
expectedBlock( DEFINITION_LIST_ITEM );
int listIndent = block.getIndent();
sink.definitionList();
sink.definitionListItem();
block.traverse();
nextBlock();
loop: while ( block != null )
{
int blockIndent = block.getIndent();
switch ( block.getType() )
{
case PARAGRAPH:
if ( blockIndent < listIndent )
{
break loop;
}
/*FALLTHROUGH*/
case VERBATIM:
case FIGURE:
case TABLE:
case HORIZONTAL_RULE:
case PG_BREAK:
block.traverse();
nextBlock();
break;
case LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
traverseList();
break;
case NUMBERED_LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
traverseNumberedList();
break;
case DEFINITION_LIST_ITEM:
if ( blockIndent < listIndent )
{
break loop;
}
if ( blockIndent > listIndent )
{
traverseDefinitionList();
}
else
{
sink.definition_();
sink.definitionListItem_();
sink.definitionListItem();
block.traverse();
nextBlock();
}
break;
case LIST_BREAK:
if ( blockIndent >= listIndent )
{
nextBlock();
}
/*FALLTHROUGH*/
default:
// A block which ends the list.
break loop;
}
}
sink.definition_();
sink.definitionListItem_();
sink.definitionList_();
}
/**
* Parse the next block of the Apt source document.
*
* @throws AptParseException if something goes wrong.
*/
private void nextBlock()
throws AptParseException
{
nextBlock( /*first*/false );
}
/**
* Parse the next block of the Apt source document.
*
* @param firstBlock True if this is the first block of the Apt source document.
* @throws AptParseException if something goes wrong.
*/
private void nextBlock( boolean firstBlock )
throws AptParseException
{
// Skip open lines.
int length, indent, i;
skipLoop: for ( ;; )
{
if ( line == null )
{
block = null;
return;
}
length = line.length();
indent = 0;
lineLoop: for ( i = 0; i < length; ++i )
{
switch ( line.charAt( i ) )
{
case SPACE:
++indent;
break;
case TAB:
indent += 8;
break;
default:
break skipLoop;
}
}
if ( i == length )
{
nextLine();
}
}
blockFileName = source.getName();
blockLineNumber = source.getLineNumber();
block = null;
switch ( line.charAt( i ) )
{
case STAR:
if ( indent == 0 )
{
if ( charAt( line, length, i + 1 ) == MINUS && charAt( line, length, i + 2 ) == MINUS )
{
block = new Table( indent, line );
}
else if ( charAt( line, length, i + 1 ) == STAR )
{
if ( charAt( line, length, i + 2 ) == STAR )
{
if ( charAt( line, length, i + 3 ) == STAR )
{
block = new Section5( indent, line );
}
else
{
block = new Section4( indent, line );
}
}
else
{
block = new Section3( indent, line );
}
}
else
{
block = new Section2( indent, line );
}
}
else
{
block = new ListItem( indent, line );
}
break;
case LEFT_SQUARE_BRACKET:
if ( charAt( line, length, i + 1 ) == RIGHT_SQUARE_BRACKET )
{
block = new ListBreak( indent, line );
}
else
{
if ( indent == 0 )
{
block = new Figure( indent, line );
}
else
{
if ( charAt( line, length, i + 1 ) == LEFT_SQUARE_BRACKET )
{
int numbering;
switch ( charAt( line, length, i + 2 ) )
{
case NUMBERING_LOWER_ALPHA_CHAR:
numbering = Sink.NUMBERING_LOWER_ALPHA;
break;
case NUMBERING_UPPER_ALPHA_CHAR:
numbering = Sink.NUMBERING_UPPER_ALPHA;
break;
case NUMBERING_LOWER_ROMAN_CHAR:
numbering = Sink.NUMBERING_LOWER_ROMAN;
break;
case NUMBERING_UPPER_ROMAN_CHAR:
numbering = Sink.NUMBERING_UPPER_ROMAN;
break;
case NUMBERING:
default:
// The first item establishes the numbering
// scheme for the whole list.
numbering = Sink.NUMBERING_DECIMAL;
}
block = new NumberedListItem( indent, line, numbering );
}
else
{
block = new DefinitionListItem( indent, line );
}
}
}
break;
case MINUS:
if ( charAt( line, length, i + 1 ) == MINUS && charAt( line, length, i + 2 ) == MINUS )
{
if ( indent == 0 )
{
block = new Verbatim( indent, line );
}
else
{
if ( firstBlock )
{
block = new Title( indent, line );
}
}
}
break;
case PLUS:
if ( indent == 0 && charAt( line, length, i + 1 ) == MINUS && charAt( line, length, i + 2 ) == MINUS )
{
block = new Verbatim( indent, line );
}
break;
case EQUAL:
if ( indent == 0 && charAt( line, length, i + 1 ) == EQUAL && charAt( line, length, i + 2 ) == EQUAL )
{
block = new HorizontalRule( indent, line );
}
break;
case PAGE_BREAK:
if ( indent == 0 )
{
block = new PageBreak( indent, line );
}
break;
case PERCENT:
if ( indent == 0 && charAt( line, length, i + 1 ) == LEFT_CURLY_BRACKET )
{
block = new MacroBlock( indent, line );
}
break;
case COMMENT:
if ( charAt( line, length, i + 1 ) == COMMENT )
{
block = new Comment( line.substring( i + 2 ).trim() );
}
break;
default:
break;
}
if ( block == null )
{
if ( indent == 0 )
{
block = new Section1( indent, line );
}
else
{
block = new Paragraph( indent, line );
}
}
}
/**
* Checks that the current block is of the expected type.
*
* @param type the expected type.
* @throws AptParseException if something goes wrong.
*/
private void expectedBlock( int type )
throws AptParseException
{
int blockType = block.getType();
if ( blockType != type )
{
throw new AptParseException( "expected " + TYPE_NAMES[type] + ", found " + TYPE_NAMES[blockType] );
}
}
// -----------------------------------------------------------------------
/**
* Determine if c is an octal character.
*
* @param c the character.
* @return boolean
*/
private static boolean isOctalChar( char c )
{
return ( c >= '0' && c <= '7' );
}
/**
* Determine if c is an hex character.
*
* @param c the character.
* @return boolean
*/
private static boolean isHexChar( char c )
{
return ( ( c >= '0' && c <= '9' ) || ( c >= 'a' && c <= 'f' ) || ( c >= 'A' && c <= 'F' ) );
}
/**
* Emits the text so far parsed into the given sink.
*
* @param buffer A StringBuffer that contains the text to be flushed.
* @param sink The sink to receive the text.
*/
private static void flushTraversed( StringBuffer buffer, Sink sink )
{
if ( buffer.length() > 0 )
{
sink.text( buffer.toString() );
buffer.setLength( 0 );
}
}
/**
* Parse the given text.
*
* @param text the text to parse.
* @param begin offset.
* @param end offset.
* @param linkAnchor a StringBuffer.
* @return int
* @throws AptParseException if something goes wrong.
*/
private static int skipTraversedLinkAnchor( String text, int begin, int end, StringBuffer linkAnchor )
throws AptParseException
{
int i;
loop: for ( i = begin; i < end; ++i )
{
char c = text.charAt( i );
switch ( c )
{
case RIGHT_CURLY_BRACKET:
break loop;
case BACKSLASH:
if ( i + 1 < end )
{
++i;
linkAnchor.append( text.charAt( i ) );
}
else
{
linkAnchor.append( BACKSLASH );
}
break;
default:
linkAnchor.append( c );
}
}
if ( i == end )
{
throw new AptParseException( "missing '" + RIGHT_CURLY_BRACKET + "'" );
}
return i;
}
/**
* Parse the given text.
*
* @param text the text to parse.
* @param begin offset.
* @param end offset.
* @return String
* @throws AptParseException if something goes wrong.
*/
private String getTraversedLink( String text, int begin, int end )
throws AptParseException
{
char previous2 = LEFT_CURLY_BRACKET;
char previous = LEFT_CURLY_BRACKET;
int i;
for ( i = begin; i < end; ++i )
{
char c = text.charAt( i );
if ( c == RIGHT_CURLY_BRACKET && previous == RIGHT_CURLY_BRACKET && previous2 != BACKSLASH )
{
break;
}
previous2 = previous;
previous = c;
}
if ( i == end )
{
throw new AptParseException( "missing '" + LEFT_CURLY_BRACKET + LEFT_CURLY_BRACKET + "'" );
}
return doGetTraversedLink( text, begin, i - 1 );
}
/**
* Parse the given text.
*
* @param text the text to parse.
* @param begin offset.
* @param end offset.
* @return String
* @throws AptParseException if something goes wrong.
*/
private String getTraversedAnchor( String text, int begin, int end )
throws AptParseException
{
char previous = LEFT_CURLY_BRACKET;
int i;
for ( i = begin; i < end; ++i )
{
char c = text.charAt( i );
if ( c == RIGHT_CURLY_BRACKET && previous != BACKSLASH )
{
break;
}
previous = c;
}
if ( i == end )
{
throw new AptParseException( "missing '" + RIGHT_CURLY_BRACKET + "'" );
}
return doGetTraversedLink( text, begin, i );
}
/**
* Parse the given text.
*
* @param text the text to parse.
* @param begin offset.
* @param end offset.
* @return String
* @throws AptParseException if something goes wrong.
*/
private String doGetTraversedLink( String text, int begin, int end )
throws AptParseException
{
final StringBuffer buffer = new StringBuffer( end - begin );
Sink linkSink = new SinkAdapter()
{
/** {@inheritDoc} */
public void lineBreak()
{
buffer.append( SPACE );
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
buffer.append( SPACE );
}
/** {@inheritDoc} */
public void text( String text )
{
buffer.append( text );
}
};
doTraverseText( text, begin, end, linkSink );
return buffer.toString().trim();
}
/**
* If debug mode is enabled, log the <code>msg</code> as is, otherwise add unique msg in <code>warnMessages</code>.
*
* @param key not null
* @param msg not null
* @see #parse(Reader, Sink)
* @since 1.1.1
*/
private void logMessage( String key, String msg )
{
msg = "[APT Parser] " + msg;
if ( getLog().isDebugEnabled() )
{
getLog().debug( msg );
return;
}
if ( warnMessages == null )
{
warnMessages = new HashMap();
}
Set set = (Set) warnMessages.get( key );
if ( set == null )
{
set = new TreeSet();
}
set.add( msg );
warnMessages.put( key, set );
}
/**
* @since 1.1.2
*/
private void logWarnings()
{
if ( getLog().isWarnEnabled() && this.warnMessages != null && !isSecondParsing() )
{
for ( Iterator it = this.warnMessages.entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
Set set = (Set) entry.getValue();
for ( Iterator it2 = set.iterator(); it2.hasNext(); )
{
String msg = (String) it2.next();
getLog().warn( msg );
}
}
this.warnMessages = null;
}
}
// -----------------------------------------------------------------------
/** A block of an apt source document. */
private abstract class Block
{
/** type. */
protected int type;
/** indent. */
protected int indent;
/** text. */
protected String text;
/** textLength. */
protected int textLength;
/**
* Constructor.
*
* @param type the block type.
* @param indent indent.
* @throws AptParseException AptParseException
*/
public Block( int type, int indent )
throws AptParseException
{
this( type, indent, null );
}
/**
* Constructor.
*
* @param type type.
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Block( int type, int indent, String firstLine )
throws AptParseException
{
this.type = type;
this.indent = indent;
// Skip first line ---
AptParser.this.nextLine();
if ( firstLine == null )
{
text = null;
textLength = 0;
}
else
{
// Read block ---
StringBuffer buffer = new StringBuffer( firstLine );
while ( AptParser.this.line != null )
{
String l = AptParser.this.line;
int length = l.length();
int i = 0;
i = skipSpace( l, length, i );
if ( i == length )
{
// Stop after open line and skip it.
AptParser.this.nextLine();
break;
}
else if ( ( AptParser.charAt( l, length, i ) == COMMENT
&& AptParser.charAt( l, length, i + 1 ) == COMMENT )
|| type == COMMENT_BLOCK )
{
// parse comments as separate blocks line by line
break;
}
buffer.append( EOL );
buffer.append( l );
AptParser.this.nextLine();
}
text = buffer.toString();
textLength = text.length();
}
}
/**
* Return the block type.
*
* @return int
*/
public final int getType()
{
return type;
}
/**
* Return the block indent.
*
* @return int
*/
public final int getIndent()
{
return indent;
}
/**
* Parse the block.
*
* @throws AptParseException if something goes wrong.
*/
public abstract void traverse()
throws AptParseException;
/**
* Traverse the text.
*
* @param begin offset.
* @throws AptParseException if something goes wrong.
*/
protected void traverseText( int begin )
throws AptParseException
{
traverseText( begin, text.length() );
}
/**
* Traverse the text.
*
* @param begin offset.
* @param end offset.
* @throws AptParseException if something goes wrong.
*/
protected void traverseText( int begin, int end )
throws AptParseException
{
AptParser.this.doTraverseText( text, begin, end, AptParser.this.sink );
}
/**
* Skip spaces.
*
* @return int.
*/
protected int skipLeadingBullets()
{
int i = skipSpaceFrom( 0 );
for ( ; i < textLength; ++i )
{
if ( text.charAt( i ) != STAR )
{
break;
}
}
return skipSpaceFrom( i );
}
/**
* Skip brackets.
*
* @param i offset.
* @return int.
* @throws AptParseException if something goes wrong.
*/
protected int skipFromLeftToRightBracket( int i )
throws AptParseException
{
char previous = LEFT_SQUARE_BRACKET;
for ( ++i; i < textLength; ++i )
{
char c = text.charAt( i );
if ( c == RIGHT_SQUARE_BRACKET && previous != BACKSLASH )
{
break;
}
previous = c;
}
if ( i == textLength )
{
throw new AptParseException( "missing '" + RIGHT_SQUARE_BRACKET + "'" );
}
return i;
}
/**
* Skip spaces.
*
* @param i offset.
* @return int.
*/
protected final int skipSpaceFrom( int i )
{
return AptParser.skipSpace( text, textLength, i );
}
}
/** A ListBreak Block. */
private class ListBreak
extends AptParser.Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public ListBreak( int indent, String firstLine )
throws AptParseException
{
super( AptParser.LIST_BREAK, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
throw new AptParseException( "internal error: traversing list break" );
}
}
/** A Title Block. */
private class Title
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Title( int indent, String firstLine )
throws AptParseException
{
super( TITLE, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
StringTokenizer lines = new StringTokenizer( text, EOL );
int separator = -1;
boolean firstLine = true;
boolean title = false;
boolean author = false;
boolean date = false;
loop: while ( lines.hasMoreTokens() )
{
String line = lines.nextToken().trim();
int lineLength = line.length();
if ( AptParser.charAt( line, lineLength, 0 ) == MINUS
&& AptParser.charAt( line, lineLength, 1 ) == MINUS
&& AptParser.charAt( line, lineLength, 2 ) == MINUS )
{
switch ( separator )
{
case 0:
if ( title )
{
AptParser.this.sink.title_();
}
else
{
throw new AptParseException( "missing title" );
}
break;
case 1:
if ( author )
{
AptParser.this.sink.author_();
}
break;
case 2:
// Note that an extra decorative line is allowed
// at the end of the author.
break loop;
default:
break;
}
++separator;
firstLine = true;
}
else
{
if ( firstLine )
{
firstLine = false;
switch ( separator )
{
case 0:
title = true;
AptParser.this.sink.title();
break;
case 1:
author = true;
AptParser.this.sink.author();
break;
case 2:
date = true;
AptParser.this.sink.date();
break;
default:
break;
}
}
else
{
// An implicit lineBreak separates title lines.
AptParser.this.sink.lineBreak();
}
AptParser.this.doTraverseText( line, 0, lineLength, AptParser.this.sink );
}
}
switch ( separator )
{
case 0:
if ( title )
{
AptParser.this.sink.title_();
}
else
{
throw new AptParseException( "missing title" );
}
break;
case 1:
if ( author )
{
AptParser.this.sink.author_();
}
break;
case 2:
if ( date )
{
AptParser.this.sink.date_();
}
break;
default:
break;
}
}
}
/** A Section Block. */
private abstract class Section
extends Block
{
/**
* Constructor.
*
* @param type type.
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Section( int type, int indent, String firstLine )
throws AptParseException
{
super( type, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
Title();
traverseText( skipLeadingBullets() );
Title_();
}
/** Start a title. */
public abstract void Title();
/** End a title. */
public abstract void Title_();
}
/** A Section1 Block. */
private class Section1
extends Section
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Section1( int indent, String firstLine )
throws AptParseException
{
super( SECTION1, indent, firstLine );
}
/** {@inheritDoc} */
public void Title()
{
AptParser.this.sink.sectionTitle1();
}
/** {@inheritDoc} */
public void Title_()
{
AptParser.this.sink.sectionTitle1_();
}
}
/** A Section2 Block. */
private class Section2
extends Section
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Section2( int indent, String firstLine )
throws AptParseException
{
super( SECTION2, indent, firstLine );
}
/** {@inheritDoc} */
public void Title()
{
AptParser.this.sink.sectionTitle2();
}
/** {@inheritDoc} */
public void Title_()
{
AptParser.this.sink.sectionTitle2_();
}
}
/** A Section3 Block. */
private class Section3
extends Section
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Section3( int indent, String firstLine )
throws AptParseException
{
super( SECTION3, indent, firstLine );
}
/** {@inheritDoc} */
public void Title()
{
AptParser.this.sink.sectionTitle3();
}
/** {@inheritDoc} */
public void Title_()
{
AptParser.this.sink.sectionTitle3_();
}
}
/** A Section4 Block. */
private class Section4
extends Section
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Section4( int indent, String firstLine )
throws AptParseException
{
super( SECTION4, indent, firstLine );
}
/** {@inheritDoc} */
public void Title()
{
AptParser.this.sink.sectionTitle4();
}
/** {@inheritDoc} */
public void Title_()
{
AptParser.this.sink.sectionTitle4_();
}
}
/** A Section5 Block. */
private class Section5
extends Section
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Section5( int indent, String firstLine )
throws AptParseException
{
super( SECTION5, indent, firstLine );
}
/** {@inheritDoc} */
public void Title()
{
AptParser.this.sink.sectionTitle5();
}
/** {@inheritDoc} */
public void Title_()
{
AptParser.this.sink.sectionTitle5_();
}
}
/** A Paragraph Block. */
private class Paragraph
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Paragraph( int indent, String firstLine )
throws AptParseException
{
super( PARAGRAPH, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
AptParser.this.sink.paragraph();
traverseText( skipSpaceFrom( 0 ) );
AptParser.this.sink.paragraph_();
}
}
/** A Comment Block. */
private class Comment
extends Block
{
/**
* Constructor.
*
* @param line the comment line.
* @throws AptParseException AptParseException
*/
public Comment( String line )
throws AptParseException
{
super( COMMENT_BLOCK, 0, line );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
AptParser.this.sink.comment( text );
}
}
/** A Verbatim Block. */
private class Verbatim
extends Block
{
/** boxed. */
private boolean boxed;
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Verbatim( int indent, String firstLine )
throws AptParseException
{
super( VERBATIM, indent, null );
// Read block (first line already skipped) ---
StringBuffer buffer = new StringBuffer();
char firstChar = firstLine.charAt( 0 );
boxed = ( firstChar == PLUS );
while ( AptParser.this.line != null )
{
String l = AptParser.this.line;
int length = l.length();
if ( AptParser.charAt( l, length, 0 ) == firstChar && AptParser.charAt( l, length, 1 ) == MINUS
&& AptParser.charAt( l, length, 2 ) == MINUS )
{
AptParser.this.nextLine();
break;
}
// Expand tabs ---
int prevColumn, column;
column = 0;
for ( int i = 0; i < length; ++i )
{
char c = l.charAt( i );
if ( c == TAB )
{
prevColumn = column;
column = ( ( column + 1 + TAB_WIDTH - 1 ) / TAB_WIDTH ) * TAB_WIDTH;
buffer.append( SPACES, 0, column - prevColumn );
}
else
{
++column;
buffer.append( c );
}
}
buffer.append( EOL );
AptParser.this.nextLine();
}
// The last '\n' is mandatory before the "---" delimeter but is
// not part of the verbatim text.
textLength = buffer.length();
if ( textLength > 0 )
{
--textLength;
buffer.setLength( textLength );
}
text = buffer.toString();
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
AptParser.this.sink.verbatim( boxed ? SinkEventAttributeSet.BOXED : null );
AptParser.this.sink.text( text );
AptParser.this.sink.verbatim_();
}
}
/** A Figure Block. */
private class Figure
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Figure( int indent, String firstLine )
throws AptParseException
{
super( FIGURE, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
AptParser.this.sink.figure();
int i = skipFromLeftToRightBracket( 0 );
AptParser.this.sink.figureGraphics( text.substring( 1, i ) );
i = skipSpaceFrom( i + 1 );
if ( i < textLength )
{
AptParser.this.sink.figureCaption();
traverseText( i );
AptParser.this.sink.figureCaption_();
}
AptParser.this.sink.figure_();
}
}
/** A Table Block. */
private class Table
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public Table( int indent, String firstLine )
throws AptParseException
{
super( TABLE, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
int captionIndex = -1;
int nextLineIndex = 0;
int init = 2;
int[] justification = null;
int rows = 0;
int columns = 0;
StringBuffer[] cells = null;
boolean[] headers = null;
boolean grid;
AptParser.this.sink.table();
while ( nextLineIndex < textLength )
{
int i = text.indexOf( "*--", nextLineIndex );
if ( i < 0 )
{
captionIndex = nextLineIndex;
break;
}
String line;
i = text.indexOf( '\n', nextLineIndex );
if ( i < 0 )
{
line = text.substring( nextLineIndex );
nextLineIndex = textLength;
}
else
{
line = text.substring( nextLineIndex, i );
nextLineIndex = i + 1;
}
int lineLength = line.length();
if ( line.indexOf( "*--" ) == 0 )
{
if ( init == 2 )
{
init = 1;
justification = parseJustification( line, lineLength );
columns = justification.length;
cells = new StringBuffer[columns];
headers = new boolean[columns];
for ( i = 0; i < columns; ++i )
{
cells[i] = new StringBuffer();
headers[i] = false;
}
}
else
{
if ( traverseRow( cells, headers, justification ) )
{
++rows;
}
justification = parseJustification( line, lineLength );
}
}
else
{
if ( init == 1 )
{
init = 0;
grid = ( AptParser.charAt( line, lineLength, 0 ) == PIPE );
AptParser.this.sink.tableRows( justification, grid );
}
line = replaceAll( line, "\\|", "\\u007C" );
StringTokenizer cellLines = new StringTokenizer( line, "|", true );
i = 0;
boolean processedGrid = false;
while ( cellLines.hasMoreTokens() )
{
String cellLine = cellLines.nextToken();
if ( "|".equals( cellLine ) )
{
if ( processedGrid )
{
headers[i] = true;
}
else
{
processedGrid = true;
headers[i] = false;
}
continue;
}
processedGrid = false;
cellLine = replaceAll( cellLine, "\\", "\\u00A0" ); // linebreak
// Escaped special characters: \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\.
cellLine = replaceAll( cellLine, "\\u00A0~", "\\~" );
cellLine = replaceAll( cellLine, "\\u00A0=", "\\=" );
cellLine = replaceAll( cellLine, "\\u00A0-", "\\-" );
cellLine = replaceAll( cellLine, "\\u00A0+", "\\+" );
cellLine = replaceAll( cellLine, "\\u00A0*", "\\*" );
cellLine = replaceAll( cellLine, "\\u00A0[", "\\[" );
cellLine = replaceAll( cellLine, "\\u00A0]", "\\]" );
cellLine = replaceAll( cellLine, "\\u00A0<", "\\<" );
cellLine = replaceAll( cellLine, "\\u00A0>", "\\>" );
cellLine = replaceAll( cellLine, "\\u00A0{", "\\{" );
cellLine = replaceAll( cellLine, "\\u00A0}", "\\}" );
cellLine = replaceAll( cellLine, "\\u00A0\\u00A0", "\\\\" );
cellLine = cellLine.trim();
StringBuffer cell = cells[i];
if ( cellLine.length() > 0 )
{
// line break in table cells
if ( cell.toString().trim().endsWith( "\\u00A0" ) )
{
cell.append( "\\\n" );
}
else
{
if ( cell.length() != 0 )
{
// Always add a space for multi line tables cells
cell.append( " " );
}
}
cell.append( cellLine );
}
++i;
if ( i == columns )
{
break;
}
}
}
}
if ( rows == 0 )
{
throw new AptParseException( "no table rows" );
}
AptParser.this.sink.tableRows_();
if ( captionIndex >= 0 )
{
AptParser.this.sink.tableCaption();
AptParser.this.doTraverseText( text, captionIndex, textLength, AptParser.this.sink );
AptParser.this.sink.tableCaption_();
}
AptParser.this.sink.table_();
}
/**
* Parse a table justification line.
*
* @param jline the justification line.
* @param lineLength the length of the line. Must be > 2.
* @return int[]
* @throws AptParseException if something goes wrong.
*/
private int[] parseJustification( String jline, int lineLength )
throws AptParseException
{
int columns = 0;
for ( int i = 2 /*Skip '*--'*/; i < lineLength; ++i )
{
switch ( jline.charAt( i ) )
{
case STAR:
case PLUS:
case COLON:
++columns;
break;
default:
break;
}
}
if ( columns == 0 )
{
throw new AptParseException( "no columns specified" );
}
int[] justification = new int[columns];
columns = 0;
for ( int i = 2; i < lineLength; ++i )
{
switch ( jline.charAt( i ) )
{
case STAR:
justification[columns++] = Sink.JUSTIFY_CENTER;
break;
case PLUS:
justification[columns++] = Sink.JUSTIFY_LEFT;
break;
case COLON:
justification[columns++] = Sink.JUSTIFY_RIGHT;
break;
default:
break;
}
}
return justification;
}
/**
* Traverse a table row.
*
* @param cells The table cells.
* @param headers true for header cells.
* @param justification the justification for each cell.
* @return boolean
* @throws AptParseException if something goes wrong.
*/
private boolean traverseRow( StringBuffer[] cells, boolean[] headers, int[] justification )
throws AptParseException
{
// Skip empty row (a decorative line).
boolean traversed = false;
for ( int i = 0; i < cells.length; ++i )
{
if ( cells[i].length() > 0 )
{
traversed = true;
break;
}
}
if ( traversed )
{
AptParser.this.sink.tableRow();
for ( int i = 0; i < cells.length; ++i )
{
StringBuffer cell = cells[i];
SinkEventAttributes justif;
switch ( justification[i] )
{
case Sink.JUSTIFY_CENTER:
justif = SinkEventAttributeSet.CENTER;
break;
case Sink.JUSTIFY_LEFT:
justif = SinkEventAttributeSet.LEFT;
break;
case Sink.JUSTIFY_RIGHT:
justif = SinkEventAttributeSet.RIGHT;
break;
default:
justif = SinkEventAttributeSet.LEFT;
break;
}
SinkEventAttributeSet event = new SinkEventAttributeSet();
event.addAttributes( justif );
if ( headers[i] )
{
AptParser.this.sink.tableHeaderCell( event );
}
else
{
AptParser.this.sink.tableCell( event );
}
if ( cell.length() > 0 )
{
AptParser.this.doTraverseText( cell.toString(), 0, cell.length(), AptParser.this.sink );
cell.setLength( 0 );
}
if ( headers[i] )
{
AptParser.this.sink.tableHeaderCell_();
}
else
{
AptParser.this.sink.tableCell_();
}
}
AptParser.this.sink.tableRow_();
}
return traversed;
}
}
/** A ListItem Block. */
private class ListItem
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public ListItem( int indent, String firstLine )
throws AptParseException
{
super( LIST_ITEM, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
traverseText( skipLeadingBullets() );
}
}
/** A NumberedListItem Block. */
private class NumberedListItem
extends Block
{
/** numbering. */
private int numbering;
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @param number numbering.
* @throws AptParseException AptParseException
*/
public NumberedListItem( int indent, String firstLine, int number )
throws AptParseException
{
super( NUMBERED_LIST_ITEM, indent, firstLine );
this.numbering = number;
}
/**
* getNumbering.
*
* @return int
*/
public int getNumbering()
{
return numbering;
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
traverseText( skipItemNumber() );
}
/**
* skipItemNumber.
*
* @return int
* @throws AptParseException AptParseException
*/
private int skipItemNumber()
throws AptParseException
{
int i = skipSpaceFrom( 0 );
char prevChar = SPACE;
for ( ; i < textLength; ++i )
{
char c = text.charAt( i );
if ( c == RIGHT_SQUARE_BRACKET && prevChar == RIGHT_SQUARE_BRACKET )
{
break;
}
prevChar = c;
}
if ( i == textLength )
{
throw new AptParseException( "missing '" + RIGHT_SQUARE_BRACKET + RIGHT_SQUARE_BRACKET + "'" );
}
return skipSpaceFrom( i + 1 );
}
}
/** A DefinitionListItem Block. */
private class DefinitionListItem
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public DefinitionListItem( int indent, String firstLine )
throws AptParseException
{
super( DEFINITION_LIST_ITEM, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
int i = skipSpaceFrom( 0 );
int j = skipFromLeftToRightBracket( i );
AptParser.this.sink.definedTerm();
traverseText( i + 1, j );
AptParser.this.sink.definedTerm_();
j = skipSpaceFrom( j + 1 );
if ( j == textLength )
{
// TODO: this doesn't handle the case of a dd in a paragraph
//throw new AptParseException( "no definition" );
}
AptParser.this.sink.definition();
traverseText( j );
}
}
/** A HorizontalRule Block. */
private class HorizontalRule
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public HorizontalRule( int indent, String firstLine )
throws AptParseException
{
super( HORIZONTAL_RULE, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
AptParser.this.sink.horizontalRule();
}
}
/** A PageBreak Block. */
private class PageBreak
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public PageBreak( int indent, String firstLine )
throws AptParseException
{
super( PG_BREAK, indent, firstLine );
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
AptParser.this.sink.pageBreak();
}
}
/** A MacroBlock Block. */
private class MacroBlock
extends Block
{
/**
* Constructor.
*
* @param indent indent.
* @param firstLine the first line.
* @throws AptParseException AptParseException
*/
public MacroBlock( int indent, String firstLine )
throws AptParseException
{
super( MACRO, indent );
text = firstLine;
}
/** {@inheritDoc} */
public void traverse()
throws AptParseException
{
if ( isSecondParsing() )
{
return;
}
String s = text;
s = s.substring( 2, s.length() - 1 );
s = escapeForMacro( s );
String[] params = StringUtils.split( s, "|" );
String macroId = params[0];
Map parameters = new HashMap();
for ( int i = 1; i < params.length; i++ )
{
String[] param = StringUtils.split( params[i], "=" );
if ( param.length == 1 )
{
throw new AptParseException( "Missing 'key=value' pair for macro parameter: " + params[i] );
}
String key = unescapeForMacro( param[0] );
String value = unescapeForMacro( param[1] );
parameters.put( key, value );
}
parameters.put( "sourceContent", sourceContent );
AptParser aptParser = new AptParser();
aptParser.setSecondParsing( true );
aptParser.enableLogging( getLog() );
parameters.put( "parser", aptParser );
// getBasedir() does not work in multi-module builds, see DOXIA-373
// the basedir should be injected from here, see DOXIA-224
MacroRequest request = new MacroRequest( parameters, getBasedir() );
try
{
AptParser.this.executeMacro( macroId, request, sink );
}
catch ( MacroExecutionException e )
{
throw new AptParseException( "Unable to execute macro in the APT document", e );
}
catch ( MacroNotFoundException e )
{
throw new AptParseException( "Unable to find macro used in the APT document", e );
}
}
/**
* escapeForMacro
*
* @param s String
* @return String
*/
private String escapeForMacro( String s )
{
if ( s == null || s.length() < 1 )
{
return s;
}
String result = s;
// use some outrageously out-of-place chars for text
// (these are device control one/two in unicode)
result = StringUtils.replace( result, "\\=", "\u0011" );
result = StringUtils.replace( result, "\\|", "\u0012" );
return result;
}
/**
* unescapeForMacro
*
* @param s String
* @return String
*/
private String unescapeForMacro( String s )
{
if ( s == null || s.length() < 1 )
{
return s;
}
String result = s;
result = StringUtils.replace( result, "\u0011", "=" );
result = StringUtils.replace( result, "\u0012", "|" );
return result;
}
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReaderSource.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptReader0000644 0001750 0001750 00000004754 11150512716 033234 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import org.codehaus.plexus.util.IOUtil;
/**
* Reader for apt source documents.
*
* @version $Id: AptReaderSource.java 746982 2009-02-23 12:25:50Z vsiveton $
*/
public class AptReaderSource
implements AptSource
{
/** A reader. */
private LineNumberReader reader;
/** lineNumber. */
private int lineNumber;
/**
* Constructor: intialize reader.
*
* @param in the reader.
*/
public AptReaderSource( Reader in )
{
reader = new LineNumberReader( in );
lineNumber = -1;
}
/** {@inheritDoc} */
public String getNextLine()
throws AptParseException
{
if ( reader == null )
{
return null;
}
String line;
try
{
line = reader.readLine();
if ( line == null )
{
reader.close();
reader = null;
}
else
{
lineNumber = reader.getLineNumber();
}
}
catch ( IOException e )
{
// TODO handle column number
throw new AptParseException( "IOException: " + e.getMessage(), e, lineNumber, -1 );
}
return line;
}
/** {@inheritDoc} */
public String getName()
{
return "";
}
/** {@inheritDoc} */
public int getLineNumber()
{
return lineNumber;
}
/**
* Closes the reader associated with this AptReaderSource.
*/
public void close()
{
IOUtil.close( reader );
reader = null;
}
}
././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptMarkup0000644 0001750 0001750 00000014471 11014267211 033262 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.markup.TextMarkup;
import org.codehaus.plexus.util.StringUtils;
/**
* This interface defines all markups and syntaxes used by the <b>APT</b> format.
*
* @see <a href="http://maven.apache.org/doxia/references/apt-format.html">http://maven.apache.org/doxia/references/apt-format.html</a>
*
* @author <a href="mailto:vincent.siveton@gmail.com">Vincent Siveton</a>
* @version $Id: AptMarkup.java 657808 2008-05-19 12:11:53Z ltheussl $
* @since 1.0
*/
public interface AptMarkup
extends TextMarkup
{
// ----------------------------------------------------------------------
// Markup separators
// ----------------------------------------------------------------------
/** APT backslash markup char: '\\' */
char BACKSLASH = '\\';
/** APT comment markup char: '~' */
char COMMENT = '~';
/** APT numbering decimal markup char: '1' */
char NUMBERING = '1';
/** APT numbering lower alpha markup char: 'a' */
char NUMBERING_LOWER_ALPHA_CHAR = 'a';
/** APT numbering lower roman markup char: 'i' */
char NUMBERING_LOWER_ROMAN_CHAR = 'i';
/** APT numbering upper alpha markup char: 'A' */
char NUMBERING_UPPER_ALPHA_CHAR = 'A';
/** APT numbering upper roman markup char: 'I' */
char NUMBERING_UPPER_ROMAN_CHAR = 'I';
/** APT page break markup char: '\f' */
char PAGE_BREAK = '\f';
/** APT percent markup char: '%' */
char PERCENT = '%';
/** APT tab markup char: '\t' */
char TAB = '\t';
// ----------------------------------------------------------------------
// Markup syntax
// ----------------------------------------------------------------------
/** Syntax for the anchor end: "}" */
String ANCHOR_END_MARKUP = String.valueOf( RIGHT_CURLY_BRACKET );
/** Syntax for the anchor start: "{" */
String ANCHOR_START_MARKUP = String.valueOf( LEFT_CURLY_BRACKET );
/** Syntax for the bold style end: ">>" */
String BOLD_END_MARKUP = StringUtils.repeat( String.valueOf( GREATER_THAN ), 2 );
/** Syntax for the bold style start: "<<" */
String BOLD_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 2 );
/** Syntax for the boxed verbatim start: "+------+" */
String BOXED_VERBATIM_START_MARKUP = String.valueOf( PLUS )
+ StringUtils.repeat( String.valueOf( MINUS ), 6 ) + String.valueOf( PLUS );
/** Syntax for the header start: " -----" */
String HEADER_START_MARKUP = String.valueOf( SPACE ) + StringUtils.repeat( String.valueOf( MINUS ), 5 );
/** Syntax for the horizontal rule: "========" */
String HORIZONTAL_RULE_MARKUP = StringUtils.repeat( String.valueOf( EQUAL ), 8 );
/** Syntax for the italic style end: ">" */
String ITALIC_END_MARKUP = String.valueOf( GREATER_THAN );
/** Syntax for the italic style start: "<" */
String ITALIC_START_MARKUP = String.valueOf( LESS_THAN );
/** Syntax for the link end: "}}" */
String LINK_END_MARKUP = StringUtils.repeat( String.valueOf( RIGHT_CURLY_BRACKET ), 2 );
/** Syntax for the link start: "{{{" */
String LINK_START_1_MARKUP = StringUtils.repeat( String.valueOf( LEFT_CURLY_BRACKET ), 3 );
/** Syntax for the link start: "}" */
String LINK_START_2_MARKUP = String.valueOf( RIGHT_CURLY_BRACKET );
/** Syntax for the list end: "[]" */
String LIST_END_MARKUP = String.valueOf( LEFT_SQUARE_BRACKET ) + String.valueOf( RIGHT_SQUARE_BRACKET );
/** Syntax for the list start: "*" */
String LIST_START_MARKUP = String.valueOf( STAR );
/** Syntax for the mono-spaced style end: ">>>" */
String MONOSPACED_END_MARKUP = StringUtils.repeat( String.valueOf( GREATER_THAN ), 3 );
/** Syntax for the mono-spaced style start: "<<<" */
String MONOSPACED_START_MARKUP = StringUtils.repeat( String.valueOf( LESS_THAN ), 3 );
/** Syntax for the non boxed verbatim start: "------" */
String NON_BOXED_VERBATIM_START_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 6 );
/** Syntax for the non breaking space: "\ " */
String NON_BREAKING_SPACE_MARKUP = String.valueOf( BACKSLASH ) + String.valueOf( SPACE );
/** Syntax for the page break: "\f" */
String PAGE_BREAK_MARKUP = String.valueOf( PAGE_BREAK );
/** Syntax for the section title start: "*" */
String SECTION_TITLE_START_MARKUP = String.valueOf( STAR );
/** Syntax for the table cell start: "|" */
String TABLE_CELL_SEPARATOR_MARKUP = String.valueOf( PIPE );
/** Syntax for the table column, centered style: "-*" */
String TABLE_COL_CENTERED_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 )
+ String.valueOf( STAR );
/** Syntax for the table column, left style: "-+" */
String TABLE_COL_LEFT_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 )
+ String.valueOf( PLUS );
/** Syntax for the table column, right style: "-:" */
String TABLE_COL_RIGHT_ALIGNED_MARKUP = StringUtils.repeat( String.valueOf( MINUS ), 2 )
+ String.valueOf( COLON );
/** Syntax for the table row end: "|" */
String TABLE_ROW_SEPARATOR_MARKUP = String.valueOf( PIPE );
/** Syntax for the table row start: "*--" */
String TABLE_ROW_START_MARKUP = String.valueOf( STAR ) + StringUtils.repeat( String.valueOf( MINUS ), 2 );
/** Syntax for the boxed verbatim end: "+------+" */
String BOXED_VERBATIM_END_MARKUP = BOXED_VERBATIM_START_MARKUP;
/** Syntax for the non boxed verbatim end: "------" */
String NON_BOXED_VERBATIM_END_MARKUP = NON_BOXED_VERBATIM_START_MARKUP;
}
././@LongLink 0000000 0000000 0000000 00000000150 00000000000 011561 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.java doxia-1.1.4/doxia-modules/doxia-module-apt/src/main/java/org/apache/maven/doxia/module/apt/AptSink.j0000644 0001750 0001750 00000053303 11331346664 033170 0 ustar twerner twerner package org.apache.maven.doxia.module.apt;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.PrintWriter;
import java.io.Writer;
import java.util.Stack;
import org.apache.maven.doxia.sink.AbstractTextSink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.codehaus.plexus.util.StringUtils;
/**
* APT Sink implementation.
* <br/>
* <b>Note</b>: The encoding used is UTF-8.
*
* @author eredmond
* @version $Id: AptSink.java 905092 2010-01-31 18:36:36Z hboutemy $
* @since 1.0
*/
public class AptSink
extends AbstractTextSink
implements AptMarkup
{
// ----------------------------------------------------------------------
// Instance fields
// ----------------------------------------------------------------------
/** A buffer that holds the current text. */
private StringBuffer buffer;
/** A buffer that holds the table caption. */
private StringBuffer tableCaptionBuffer;
/** author. */
private String author;
/** title. */
private String title;
/** date. */
private String date;
/** startFlag. */
private boolean startFlag;
/** tableCaptionFlag. */
private boolean tableCaptionFlag;
/** headerFlag. */
private boolean headerFlag;
/** bufferFlag. */
private boolean bufferFlag;
/** itemFlag. */
private boolean itemFlag;
/** verbatimFlag. */
private boolean verbatimFlag;
/** boxed verbatim. */
private boolean isBoxed;
/** gridFlag for tables. */
private boolean gridFlag;
/** number of cells in a table. */
private int cellCount;
/** The writer to use. */
private final PrintWriter writer;
/** justification of table cells. */
private int cellJustif[];
/** a line of a row in a table. */
private String rowLine;
/** listNestingIndent. */
private String listNestingIndent;
/** listStyles. */
private final Stack listStyles;
// ----------------------------------------------------------------------
// Public protected methods
// ----------------------------------------------------------------------
/**
* Constructor, initialize the Writer and the variables.
*
* @param writer not null writer to write the result. <b>Should</b> be an UTF-8 Writer.
* You could use <code>newWriter</code> methods from {@link org.codehaus.plexus.util.WriterFactory}.
*/
protected AptSink( Writer writer )
{
this.writer = new PrintWriter( writer );
this.listStyles = new Stack();
init();
}
/**
* Returns the buffer that holds the current text.
*
* @return A StringBuffer.
*/
protected StringBuffer getBuffer()
{
return buffer;
}
/**
* Used to determine whether we are in head mode.
*
* @param headFlag True for head mode.
*/
protected void setHeadFlag( boolean headFlag )
{
this.headerFlag = headFlag;
}
/**
* Reset all variables.
*
* @deprecated since 1.1.2, use {@link #init()} instead of.
*/
protected void resetState()
{
init();
}
/** {@inheritDoc} */
protected void init()
{
super.init();
resetBuffer();
this.tableCaptionBuffer = new StringBuffer();
this.listNestingIndent = "";
this.author = null;
this.title = null;
this.date = null;
this.startFlag = true;
this.tableCaptionFlag = false;
this.headerFlag = false;
this.bufferFlag = false;
this.itemFlag = false;
this.verbatimFlag = false;
this.isBoxed = false;
this.gridFlag = false;
this.cellCount = 0;
this.cellJustif = null;
this.rowLine = null;
this.listStyles.clear();
}
/**
* Reset the StringBuffer.
*/
protected void resetBuffer()
{
buffer = new StringBuffer();
}
/**
* Reset the TableCaptionBuffer.
*/
protected void resetTableCaptionBuffer()
{
tableCaptionBuffer = new StringBuffer();
}
/** {@inheritDoc} */
public void head()
{
boolean startFlag = this.startFlag;
init();
headerFlag = true;
this.startFlag = startFlag;
}
/** {@inheritDoc} */
public void head_()
{
headerFlag = false;
if ( ! startFlag )
{
write( EOL );
}
write( HEADER_START_MARKUP + EOL );
if ( title != null )
{
write( " " + title + EOL );
}
write( HEADER_START_MARKUP + EOL );
if ( author != null )
{
write( " " + author + EOL );
}
write( HEADER_START_MARKUP + EOL );
if ( date != null )
{
write( " " + date + EOL );
}
write( HEADER_START_MARKUP + EOL );
}
/** {@inheritDoc} */
public void title_()
{
if ( buffer.length() > 0 )
{
title = buffer.toString();
resetBuffer();
}
}
/** {@inheritDoc} */
public void author_()
{
if ( buffer.length() > 0 )
{
author = buffer.toString();
resetBuffer();
}
}
/** {@inheritDoc} */
public void date_()
{
if ( buffer.length() > 0 )
{
date = buffer.toString();
resetBuffer();
}
}
/** {@inheritDoc} */
public void section1_()
{
write( EOL );
}
/** {@inheritDoc} */
public void section2_()
{
write( EOL );
}
/** {@inheritDoc} */
public void section3_()
{
write( EOL );
}
/** {@inheritDoc} */
public void section4_()
{
write( EOL );
}
/** {@inheritDoc} */
public void section5_()
{
write( EOL );
}
/** {@inheritDoc} */
public void sectionTitle1()
{
write( EOL );
}
/** {@inheritDoc} */
public void sectionTitle1_()
{
write( EOL + EOL );
}
/** {@inheritDoc} */
public void sectionTitle2()
{
write( EOL + SECTION_TITLE_START_MARKUP );
}
/** {@inheritDoc} */
public void sectionTitle2_()
{
write( EOL + EOL );
}
/** {@inheritDoc} */
public void sectionTitle3()
{
write( EOL + StringUtils.repeat( SECTION_TITLE_START_MARKUP, 2 ) );
}
/** {@inheritDoc} */
public void sectionTitle3_()
{
write( EOL + EOL );
}
/** {@inheritDoc} */
public void sectionTitle4()
{
write( EOL + StringUtils.repeat( SECTION_TITLE_START_MARKUP, 3 ) );
}
/** {@inheritDoc} */
public void sectionTitle4_()
{
write( EOL + EOL );
}
/** {@inheritDoc} */
public void sectionTitle5()
{
write( EOL + StringUtils.repeat( SECTION_TITLE_START_MARKUP, 4 ) );
}
/** {@inheritDoc} */
public void sectionTitle5_()
{
write( EOL + EOL );
}
/** {@inheritDoc} */
public void list()
{
listNestingIndent += " ";
listStyles.push( LIST_START_MARKUP );
write( EOL );
}
/** {@inheritDoc} */
public void list_()
{
if ( listNestingIndent.length() <= 1 )
{
write( EOL + listNestingIndent + LIST_END_MARKUP + EOL );
}
else
{
write( EOL );
}
listNestingIndent = StringUtils.chomp( listNestingIndent, " " );
listStyles.pop();
itemFlag = false;
}
/** {@inheritDoc} */
public void listItem()
{
//if ( !numberedList )
//write( EOL + listNestingIndent + "*" );
//else
numberedListItem();
itemFlag = true;
}
/** {@inheritDoc} */
public void listItem_()
{
write( EOL );
itemFlag = false;
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
listNestingIndent += " ";
write( EOL );
String style;
switch ( numbering )
{
case NUMBERING_UPPER_ALPHA:
style = String.valueOf( NUMBERING_UPPER_ALPHA_CHAR );
break;
case NUMBERING_LOWER_ALPHA:
style = String.valueOf( NUMBERING_LOWER_ALPHA_CHAR );
break;
case NUMBERING_UPPER_ROMAN:
style = String.valueOf( NUMBERING_UPPER_ROMAN_CHAR );
break;
case NUMBERING_LOWER_ROMAN:
style = String.valueOf( NUMBERING_LOWER_ROMAN_CHAR );
break;
case NUMBERING_DECIMAL:
default:
style = String.valueOf( NUMBERING );
}
listStyles.push( style );
}
/** {@inheritDoc} */
public void numberedList_()
{
if ( listNestingIndent.length() <= 1 )
{
write( EOL + listNestingIndent + LIST_END_MARKUP + EOL );
}
else
{
write( EOL );
}
listNestingIndent = StringUtils.chomp( listNestingIndent, " " );
listStyles.pop();
itemFlag = false;
}
/** {@inheritDoc} */
public void numberedListItem()
{
String style = (String) listStyles.peek();
if ( style.equals( String.valueOf( STAR ) ) )
{
write( EOL + listNestingIndent + String.valueOf( STAR ) + String.valueOf( SPACE ) );
}
else
{
write( EOL + listNestingIndent + String.valueOf( LEFT_SQUARE_BRACKET )
+ String.valueOf( LEFT_SQUARE_BRACKET ) + style + String.valueOf( RIGHT_SQUARE_BRACKET )
+ String.valueOf( RIGHT_SQUARE_BRACKET ) + String.valueOf( SPACE ) );
}
itemFlag = true;
}
/** {@inheritDoc} */
public void numberedListItem_()
{
write( EOL );
itemFlag = false;
}
/** {@inheritDoc} */
public void definitionList()
{
listNestingIndent += " ";
listStyles.push( "" );
write( EOL );
}
/** {@inheritDoc} */
public void definitionList_()
{
if ( listNestingIndent.length() <= 1 )
{
write( EOL + listNestingIndent + LIST_END_MARKUP + EOL );
}
else
{
write( EOL );
}
listNestingIndent = StringUtils.chomp( listNestingIndent, " " );
listStyles.pop();
itemFlag = false;
}
/** {@inheritDoc} */
public void definedTerm()
{
write( EOL + " [" );
}
/** {@inheritDoc} */
public void definedTerm_()
{
write( "] " );
}
/** {@inheritDoc} */
public void definition()
{
itemFlag = true;
}
/** {@inheritDoc} */
public void definition_()
{
write( EOL );
itemFlag = false;
}
/** {@inheritDoc} */
public void pageBreak()
{
write( EOL + PAGE_BREAK + EOL );
}
/** {@inheritDoc} */
public void paragraph()
{
if ( itemFlag )
{
write( EOL + EOL + " " + listNestingIndent );
}
else
{
write( EOL + " " );
}
}
/** {@inheritDoc} */
public void paragraph_()
{
write( EOL + EOL );
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
verbatimFlag = true;
this.isBoxed = boxed;
write( EOL );
if ( boxed )
{
write( EOL + BOXED_VERBATIM_START_MARKUP + EOL );
}
else
{
write( EOL + NON_BOXED_VERBATIM_START_MARKUP + EOL );
}
}
/** {@inheritDoc} */
public void verbatim_()
{
if ( isBoxed )
{
write( EOL + BOXED_VERBATIM_END_MARKUP + EOL );
}
else
{
write( EOL + NON_BOXED_VERBATIM_END_MARKUP + EOL );
}
isBoxed = false;
verbatimFlag = false;
}
/** {@inheritDoc} */
public void horizontalRule()
{
write( EOL + HORIZONTAL_RULE_MARKUP + EOL );
}
/** {@inheritDoc} */
public void table()
{
write( EOL );
}
/** {@inheritDoc} */
public void table_()
{
if ( rowLine != null )
{
write( rowLine );
}
rowLine = null;
if ( tableCaptionBuffer.length() > 0 )
{
text( tableCaptionBuffer.toString() + EOL );
}
resetTableCaptionBuffer();
}
/** {@inheritDoc} */
public void tableRows( int justification[], boolean grid )
{
cellJustif = justification;
gridFlag = grid;
}
/** {@inheritDoc} */
public void tableRows_()
{
cellJustif = null;
gridFlag = false;
}
/** {@inheritDoc} */
public void tableRow()
{
bufferFlag = true;
cellCount = 0;
}
/** {@inheritDoc} */
public void tableRow_()
{
bufferFlag = false;
// write out the header row first, then the data in the buffer
buildRowLine();
write( rowLine );
// TODO: This will need to be more clever, for multi-line cells
if ( gridFlag )
{
write( TABLE_ROW_SEPARATOR_MARKUP );
}
write( buffer.toString() );
resetBuffer();
write( EOL );
// only reset cell count if this is the last row
cellCount = 0;
}
/** Construct a table row. */
private void buildRowLine()
{
StringBuffer rLine = new StringBuffer();
rLine.append( TABLE_ROW_START_MARKUP );
for ( int i = 0; i < cellCount; i++ )
{
if ( cellJustif != null )
{
switch ( cellJustif[i] )
{
case 1:
rLine.append( TABLE_COL_LEFT_ALIGNED_MARKUP );
break;
case 2:
rLine.append( TABLE_COL_RIGHT_ALIGNED_MARKUP );
break;
default:
rLine.append( TABLE_COL_CENTERED_ALIGNED_MARKUP );
}
}
else
{
rLine.append( TABLE_COL_CENTERED_ALIGNED_MARKUP );
}
}
rLine.append( EOL );
this.rowLine = rLine.toString();
}
/** {@inheritDoc} */
public void tableCell()
{
tableCell( false );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
tableCell( true );
}
/**
* Starts a table cell.
*
* @param headerRow If this cell is part of a header row.
*/
public void tableCell( boolean headerRow )
{
if ( headerRow )
{
buffer.append( TABLE_CELL_SEPARATOR_MARKUP );
}
}
/** {@inheritDoc} */
public void tableCell_()
{
endTableCell();
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
endTableCell();
}
/**
* Ends a table cell.
*/
private void endTableCell()
{
buffer.append( TABLE_CELL_SEPARATOR_MARKUP );
cellCount++;
}
/** {@inheritDoc} */
public void tableCaption()
{
tableCaptionFlag = true;
}
/** {@inheritDoc} */
public void tableCaption_()
{
tableCaptionFlag = false;
}
/** {@inheritDoc} */
public void figureCaption_()
{
write( EOL );
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
write( EOL + "[" + name + "] " );
}
/** {@inheritDoc} */
public void anchor( String name )
{
write( ANCHOR_START_MARKUP );
}
/** {@inheritDoc} */
public void anchor_()
{
write( ANCHOR_END_MARKUP );
}
/** {@inheritDoc} */
public void link( String name )
{
if ( !headerFlag )
{
write( LINK_START_1_MARKUP );
text( name.startsWith( "#" ) ? name.substring( 1 ) : name );
write( LINK_START_2_MARKUP );
}
}
/** {@inheritDoc} */
public void link_()
{
if ( !headerFlag )
{
write( LINK_END_MARKUP );
}
}
/**
* A link with a target.
*
* @param name The name of the link.
* @param target The link target.
*/
public void link( String name, String target )
{
if ( !headerFlag )
{
write( LINK_START_1_MARKUP );
text( target );
write( LINK_START_2_MARKUP );
text( name );
}
}
/** {@inheritDoc} */
public void italic()
{
if ( !headerFlag )
{
write( ITALIC_START_MARKUP );
}
}
/** {@inheritDoc} */
public void italic_()
{
if ( !headerFlag )
{
write( ITALIC_END_MARKUP );
}
}
/** {@inheritDoc} */
public void bold()
{
if ( !headerFlag )
{
write( BOLD_START_MARKUP );
}
}
/** {@inheritDoc} */
public void bold_()
{
if ( !headerFlag )
{
write( BOLD_END_MARKUP );
}
}
/** {@inheritDoc} */
public void monospaced()
{
if ( !headerFlag )
{
write( MONOSPACED_START_MARKUP );
}
}
/** {@inheritDoc} */
public void monospaced_()
{
if ( !headerFlag )
{
write( MONOSPACED_END_MARKUP );
}
}
/** {@inheritDoc} */
public void lineBreak()
{
if ( headerFlag || bufferFlag )
{
buffer.append( EOL );
}
else if ( verbatimFlag )
{
write( EOL );
}
else
{
write( "\\" + EOL );
}
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
if ( headerFlag || bufferFlag )
{
buffer.append( NON_BREAKING_SPACE_MARKUP );
}
else
{
write( NON_BREAKING_SPACE_MARKUP );
}
}
/** {@inheritDoc} */
public void text( String text )
{
if ( tableCaptionFlag )
{
tableCaptionBuffer.append( text );
}
else if ( headerFlag || bufferFlag )
{
buffer.append( text );
}
else if ( verbatimFlag )
{
verbatimContent( text );
}
else
{
content( text );
}
}
/** {@inheritDoc} */
public void rawText( String text )
{
write( text );
}
/** {@inheritDoc} */
public void comment( String comment )
{
rawText( ( startFlag ? "" : EOL ) + COMMENT + COMMENT + SPACE + comment.trim() );
}
/**
* {@inheritDoc}
*
* Unkown events just log a warning message but are ignored otherwise.
* @see org.apache.maven.doxia.sink.Sink#unknown(String,Object[],SinkEventAttributes)
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
getLog().warn( "[Apt Sink] Unknown Sink event: '" + name + "', ignoring!" );
}
/**
* Write text to output.
*
* @param text The text to write.
*/
protected void write( String text )
{
startFlag = false;
writer.write( unifyEOLs( text ) );
}
/**
* Write Apt escaped text to output.
*
* @param text The text to write.
*/
protected void content( String text )
{
write( escapeAPT( text ) );
}
/**
* Write Apt escaped text to output.
*
* @param text The text to write.
*/
protected void verbatimContent( String text )
{
write( escapeAPT( text ) );
}
/** {@inheritDoc} */
public void flush()
{
writer.flush();
}
/** {@inheritDoc} */
public void close()
{
writer.close();
init();
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
/**
* Escape special characters in a text in APT:
*
* <pre>
* \~, \=, \-, \+, \*, \[, \], \<, \>, \{, \}, \\
* </pre>
*
* @param text the String to escape, may be null
* @return the text escaped, "" if null String input
*/
private static String escapeAPT( String text )
{
if ( text == null )
{
return "";
}
int length = text.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = text.charAt( i );
switch ( c )
{ // 0080
case '\\':
case '~':
case '=':
case '-':
case '+':
case '*':
case '[':
case ']':
case '<':
case '>':
case '{':
case '}':
buffer.append( '\\' );
buffer.append( c );
break;
default:
buffer.append( c );
}
}
return buffer.toString();
}
}
doxia-1.1.4/doxia-modules/doxia-module-xdoc/ 0000755 0001750 0001750 00000000000 11632765557 020674 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/pom.xml 0000644 0001750 0001750 00000011776 11470562366 022216 0 ustar twerner twerner <?xml version="1.0" encoding="UTF-8"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>doxia-modules</artifactId>
<groupId>org.apache.maven.doxia</groupId>
<version>1.1.4</version>
<relativePath>../pom.xml</relativePath>
</parent>
<artifactId>doxia-module-xdoc</artifactId>
<name>Doxia :: XDoc Module</name>
<description>A Doxia module for Xdoc source documents.</description>
<dependencies>
<dependency>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-utils</artifactId>
</dependency>
<!-- test -->
<dependency>
<groupId>org.apache.maven.doxia</groupId>
<artifactId>doxia-test-docs</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>xerces</groupId>
<artifactId>xercesImpl</artifactId>
<version>2.9.1</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration>
<excludes>
<!-- See DOXIA-408 -->
<exclude>org/apache/maven/doxia/module/xdoc/XmlWriterXdocSinkTest.java</exclude>
</excludes>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.plexus</groupId>
<artifactId>plexus-maven-plugin</artifactId>
<configuration>
<descriptors>
<descriptor>src/main/components/components.xml</descriptor>
<descriptor>target/generated-resources/plexus/META-INF/plexus/components.xml</descriptor>
</descriptors>
</configuration>
<executions>
<execution>
<goals>
<goal>merge-descriptors</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>
<profiles>
<profile>
<id>reporting</id>
<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-antrun-plugin</artifactId>
<executions>
<execution>
<phase>site</phase>
<configuration>
<tasks>
<taskdef name="xsddoc" classname="net.sf.xframe.xsddoc.Task" />
<condition property="dir" value="${project.reporting.outputDirectory}/xsddoc">
<matches string="${project.reporting.outputDirectory}" pattern="^${basedir}" />
</condition>
<condition property="dir" value="${project.reporting.outputDirectory}/xsddoc">
<not>
<isset property="dir" />
</not>
</condition>
<mkdir dir="${dir}" />
<xsddoc file="${basedir}/src/main/resources/xdoc-2.0.xsd" out="${dir}" doctitle="Reference of Schema Xdoc 2.0" verbose="true" />
</tasks>
</configuration>
<goals>
<goal>run</goal>
</goals>
</execution>
</executions>
<dependencies>
<dependency>
<groupId>xsddoc</groupId>
<artifactId>xsddoc</artifactId>
<version>1.0</version>
<exclusions>
<exclusion>
<groupId>ant</groupId>
<artifactId>ant</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.apache.ant</groupId>
<artifactId>ant-apache-regexp</artifactId>
<version>1.7.1</version>
</dependency>
<dependency>
<groupId>xalan</groupId>
<artifactId>xalan</artifactId>
<version>2.7.1</version>
</dependency>
</dependencies>
</plugin>
</plugins>
</build>
</profile>
</profiles>
</project>
doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/ 0000755 0001750 0001750 00000000000 11632765557 021463 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/ 0000755 0001750 0001750 00000000000 11632765556 022441 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765556 024453 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/resources/toc.xml 0000644 0001750 0001750 00000003246 11136075263 025753 0 ustar twerner twerner <?xml version="1.0"?>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 file:../../main/resources/xdoc-2.0.xsd">
<properties>
<title>Test DOXIA-40Vincent Siveton
doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/ 0000755 0001750 0001750 00000000000 11632765556 023362 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765556 024151 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765556 025372 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765556 026500 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765556 027604 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765556 031071 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/ 0000755 0001750 0001750 00000000000 11632765556 032026 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000170 00000000000 011563 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XmlWriterXdocSinkTest.java doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XmlWrit0000644 0001750 0001750 00000007203 11352225025 033336 0 ustar twerner twerner package org.apache.maven.doxia.module.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
import org.codehaus.plexus.util.xml.XmlUtil;
/**
* @author Vincent Siveton
* @version $Id: XmlWriterXdocSinkTest.java 926772 2010-03-23 20:52:37Z ltheussl $
* @since 1.1
*/
public class XmlWriterXdocSinkTest
extends XdocSinkTest
{
private static final String DEFAULT_INDENT = StringUtils.repeat( " ", XmlUtil.DEFAULT_INDENTATION_SIZE );
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new XmlWriterXdocSink( new PrettyPrintXMLWriter( writer ) );
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return "";
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return "";
}
/** {@inheritDoc} */
protected String getListBlock( String item )
{
return "
";
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return " ";
}
}
././@LongLink 0000000 0000000 0000000 00000000163 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocIdentityTest.java doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocIde0000644 0001750 0001750 00000005216 11207760055 033257 0 ustar twerner twerner package org.apache.maven.doxia.module.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.module.AbstractIdentityTest;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
/**
* Check that piping a full model through an XdocParser and an XdocSink
* leaves the model unchanged.
*/
public class XdocIdentityTest
extends AbstractIdentityTest
{
/** {@inheritDoc} */
protected void setUp()
throws Exception
{
super.setUp();
assertIdentity( true );
}
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new XdocSink( writer );
}
/** {@inheritDoc} */
protected Parser createParser()
{
return new XdocParser();
}
/** {@inheritDoc} */
protected String getExpected()
{
// DOXIA-177
String expected = super.getExpected();
String startCaption = "begin:tableCaption";
String endCaption = "end:tableCaption";
int iStartCaption = expected.indexOf( startCaption );
int iEndCaption = expected.indexOf( endCaption ) + endCaption.length();
String captionTag = expected.substring( iStartCaption, iEndCaption ) + EOL + EOL + EOL;
expected = StringUtils.replace( expected, captionTag, "" );
int iStartTableRows =
expected.substring( 0, iStartCaption ).lastIndexOf( "begin:tableRows" ) + "begin:tableRows".length();
StringBuffer text = new StringBuffer();
text.append( expected.substring( 0, iStartTableRows ) );
text.append( EOL + EOL + EOL );
text.append( captionTag.subSequence( 0, captionTag.indexOf( "end:tableCaption" )
+ "end:tableCaption".length() ) );
text.append( expected.substring( iStartTableRows ) );
return text.toString();
}
}
././@LongLink 0000000 0000000 0000000 00000000157 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSinkTest.java doxia-1.1.4/doxia-modules/doxia-module-xdoc/src/test/java/org/apache/maven/doxia/module/xdoc/XdocSin0000644 0001750 0001750 00000016455 11352225025 033310 0 ustar twerner twerner package org.apache.maven.doxia.module.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.AbstractSinkTest;
import org.apache.maven.doxia.util.HtmlTools;
import java.io.StringWriter;
import java.io.Writer;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* @author Jason van Zyl
* @version $Id: XdocSinkTest.java 926772 2010-03-23 20:52:37Z ltheussl $
* @since 1.0
*/
public class XdocSinkTest
extends AbstractSinkTest
{
/** {@inheritDoc} */
protected String outputExtension()
{
return "xml";
}
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new XdocSink( writer, "UTF-8" );
}
/** {@inheritDoc} */
protected boolean isXmlSink()
{
return true;
}
/** {@inheritDoc} */
protected String getTitleBlock( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getAuthorBlock( String author )
{
return author;
}
/** {@inheritDoc} */
protected String getDateBlock( String date )
{
return date;
}
/** {@inheritDoc} */
protected String getHeadBlock()
{
return ""
+ ""
+ "";
}
/** {@inheritDoc} */
protected String getBodyBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getSectionTitleBlock( String title )
{
return title;
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return "";
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return "";
}
/** {@inheritDoc} */
protected String getSection3Block( String title )
{
return "
Currently only a sink is available, ie you can generate FO files
either programmatically or by converting from any other
input format
supported by Doxia, but you cannot parse them.
The generated FO files can then be converted into other formats,
eg pdf, using Apache Fop.
Check out the usage examples.
Table captions not implemented
Table width is fixed and column widths are uniformly distributed
Here's an example that converts a single apt input file into a fo document.
To produce a pdf from the result using Apache FOP, see eg
ExampleFO2PDF.
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import org.apache.maven.doxia.module.apt.AptParser;
import org.apache.maven.doxia.module.fo.FoSink;
import org.apache.maven.doxia.parser.ParseException;
public class Apt2FO
{
public static void main(String[] args)
{
try
{
// Open input apt document:
FileReader source = new FileReader(
new File( "resources", "test.apt" ) );
// Create FO sink:
FoSink fosink = new FoSink( new FileWriter(
new File( "output", "test.fo" ) ) );
AptParser parser = new AptParser();
parser.parse( source, fosink );
// close streams
fosink.close();
source.close();
}
catch ( ParseException e )
{
e.printStackTrace();
}
catch ( FileNotFoundException e )
{
e.printStackTrace();
}
catch ( IOException e )
{
e.printStackTrace();
}
}
}
If you want to parse several source documents into a single fo file,
so you can generate a single pdf from multiple source files, you should
use the FoAggregateSink. A simple example is outlined below,
refer to the API docs for more information.
AptParser parser = new AptParser();
FoAggregateSink fosink = new FoAggregateSink(
new FileWriter( new File( "out", "aggregate.fo" ) ) );
// getDocumentModel() should return a DocumentModel object
fosink.setDocumentModel( getDocumentModel() );
fosink.beginDocument();
fosink.coverPage();
fosink.toc();
// first document
FileReader source1 =
new FileReader( new File( "resources", "test1.apt" ) );
fosink.setDocumentName( "doc1" );
fosink.setDocumentTitle( "Document 1" );
parser.parse( source1, fosink );
// second document
FileReader source2 =
new FileReader( new File( "resources", "test2.apt" ) );
fosink.setDocumentName( "doc2" );
fosink.setDocumentTitle( "Document 2" );
parser.parse( source2, fosink );
fosink.endDocument();
To compile and run the following example,
you need the following jars on your classpath:
doxia-core-1.1.1, doxia-module-fo-1.1.1,
doxia-sink-api-1.1.1, doxia-logging-api-1.1.1,
commons-configuration-1.4, commons-lang-2.4,
plexus-utils-1.5.8, commons-collections-3.2,
commons-logging-1.1.1.
doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/ 0000755 0001750 0001750 00000000000 11632765560 022050 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/resources/ 0000755 0001750 0001750 00000000000 11632765560 024062 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/resources/doxia-fo.properties 0000644 0001750 0001750 00000001546 11203760157 027703 0 ustar twerner twerner # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
footer.rights=ALL RIGHTS RESERVED.
footer.confidential=PROPRIETARY AND CONFIDENTIAL
doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/resources/doxia-fo_en.properties 0000644 0001750 0001750 00000002276 11203760157 030366 0 ustar twerner twerner # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# NOTE:
# This bundle is intentionally empty because English strings are provided by the base bundle via the parent chain. It
# must be provided nevertheless such that a request for locale "en" will not errorneously pick up the bundle for the
# JVM's default locale (which need not be "en"). See the method javadoc about
# ResourceBundle.getBundle(String, Locale, ClassLoader)
# for a full description of the lookup strategy.
doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/resources/fo-styles.xslt 0000644 0001750 0001750 00000066351 11212474726 026731 0 ustar twerner twerner
8.27in11.70in0.625in0.6in1in1incover-page0.7incover-inside0in0in0in0intoc0.7in0.8in0.35in0.125inbody0.7in0.8in0.35in0.125inGaramond,serifHelvetica,sans-serif#000000alwaysmonospaceitalicboldmonospace10pt11pt12pttrue10ptinherited-property-value(start-indent) + 1eminherited-property-value(end-indent) + 1emno-wrapalwaysfalseblacksolid0.5pt#4545450.25em0.25em0.25em0.25eminherited-property-value(start-indent) + 2.5eminherited-property-value(end-indent) + 3em0.75em1em100%rule0.5ptblackHelvetica,sans-serif9.0pt16ptbold12ptbold18pt6pt9.5ptbold18pt5pt9.5pt15pt3pt9.5pt9pt3pt9.5ptitalic3pt10pt6pt100%dots1pt#4545459.5pt10ptright2ptHelvetica,sans-serif6pt#4545452ptHelvetica,sans-serif6pt#454545leftHelvetica,sans-serif9.5ptrightblackbluegreen3pt6ptinherited-property-value(start-indent)10pt1em1eminherited-property-value(start-indent) + 1em0.15em0.25em1em1em1em1emboldinherited-property-value(start-indent) + 1eminherited-property-value(end-indent) + 1em0.6em0.6em8ptboldredsolid0.5ptred0.75eminherited-property-value(start-indent) + 2.5eminherited-property-value(end-indent) + 3emHelvetica,sans-serif#000000always16ptboldleftcenter0.5inHelvetica,sans-serif#000000always12ptboldleftcenter0.2indotted0.1pt#0000000.2indotted0.1pt#000000center16pt30pt14ptcenter12pt20pt14ptcenter12pt20pt30ptcentercenterautoautoautoautoalwayscenter10ptitalic20pt30ptfalsefixed100%100%rule0.5ptblack2.5pt5ptalwaysHelvetica,sans-serif1.2em9pt12ptalwaysalwayssolid0.5ptblack11ptbold5pt9ptitalic7ptafter#bbbbbbwhite10ptbold100%rule0.5ptblack6pt9ptitalicalwaysalways1pt#D3D3D3solid2.5pt#D3D3D3after9ptboldbottomautoauto100%rule1ptwhite100%dots0.5pt#A9A9A9100%rule0.5ptblacksolid0.2mm4pt1.5pt#eeeeee9pt9ptafterHelvetica,sans-serif16ptjustifyno-wrapdots5pt#4545459.5ptend#A9A9A916pt6pt12ptbold18pt11pt15pt3pt10pt4pt9.5pt4pt
doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/resources/log4j.properties 0000644 0001750 0001750 00000002027 10753326600 027207 0 ustar twerner twerner # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
log4j.rootCategory=INFO, stdout
log4j.appender.stdout=org.apache.log4j.ConsoleAppender
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
log4j.appender.stdout.layout.ConversionPattern=%5p [%c:%L] %d{ISO8601} - %m%n
log4j.logger.org.apache.fop=ERROR
doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/ 0000755 0001750 0001750 00000000000 11632765557 022777 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765557 023566 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765557 025007 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765557 026115 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765557 027221 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765557 030506 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/ 0000755 0001750 0001750 00000000000 11632765560 031104 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000147 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoMarkup.java doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoMarkup.ja0000644 0001750 0001750 00000016764 11147530374 033154 0 ustar twerner twerner package org.apache.maven.doxia.module.fo;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.markup.XmlMarkup;
/**
* List of FO markups.
*
* @author ltheussl
* @version $Id: FoMarkup.java 746232 2009-02-20 13:32:44Z ltheussl $
* @since 1.1
*/
public interface FoMarkup
extends XmlMarkup
{
/** FO namespace: "http://www.w3.org/1999/XSL/Format" */
String FO_NAMESPACE = "http://www.w3.org/1999/XSL/Format";
// ----------------------------------------------------------------------
// Specific FO tags
// ----------------------------------------------------------------------
/** FO tag for root. */
Tag ROOT_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "root";
}
};
/** FO tag for layout-master-set. */
Tag LAYOUT_MASTER_SET_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "layout-master-set";
}
};
/** FO tag for simple-page-master. */
Tag SIMPLE_PAGE_MASTER_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "simple-page-master";
}
};
/** FO tag for region-body. */
Tag REGION_BODY_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "region-body";
}
};
/** FO tag for region-before. */
Tag REGION_BEFORE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "region-before";
}
};
/** FO tag for region-after. */
Tag REGION_AFTER_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "region-after";
}
};
/** FO tag for static-content. */
Tag STATIC_CONTENT_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "static-content";
}
};
/** FO tag for page-sequence. */
Tag PAGE_SEQUENCE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "page-sequence";
}
};
/** FO tag for flow. */
Tag FLOW_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "flow";
}
};
/** FO tag for block. */
Tag BLOCK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "block";
}
};
/** FO tag for list-block. */
Tag LIST_BLOCK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "list-block";
}
};
/** FO tag for list-item. */
Tag LIST_ITEM_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "list-item";
}
};
/** FO tag for list-item-body. */
Tag LIST_ITEM_BODY_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "list-item-body";
}
};
/** FO tag for list-item-label. */
Tag LIST_ITEM_LABEL_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "list-item-label";
}
};
/** FO tag for table-and-caption. */
Tag TABLE_AND_CAPTION_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table-and-caption";
}
};
/** FO tag for table. */
Tag TABLE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table";
}
};
/** FO tag for table-body. */
Tag TABLE_BODY_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table-body";
}
};
/** FO tag for table-column. */
Tag TABLE_COLUMN_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table-column";
}
};
/** FO tag for table-row. */
Tag TABLE_ROW_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table-row";
}
};
/** FO tag for table-cell. */
Tag TABLE_CELL_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table-cell";
}
};
/** FO tag for table-caption. */
Tag TABLE_CAPTION_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "table-caption";
}
};
/** FO tag for inline. */
Tag INLINE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "inline";
}
};
/** FO tag for basic-link. */
Tag BASIC_LINK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "basic-link";
}
};
/** FO tag for leader. */
Tag LEADER_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "leader";
}
};
/** FO tag for page-number. */
Tag PAGE_NUMBER_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "page-number";
}
};
/** FO tag for page-number-citation. */
Tag PAGE_NUMBER_CITATION_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "page-number-citation";
}
};
/** FO tag for bookmark-tree. */
Tag BOOKMARK_TREE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "bookmark-tree";
}
};
/** FO tag for bookmark. */
Tag BOOKMARK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "bookmark";
}
};
/** FO tag for bookmark-title. */
Tag BOOKMARK_TITLE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "bookmark-title";
}
};
}
././@LongLink 0000000 0000000 0000000 00000000146 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.java doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoUtils.jav0000644 0001750 0001750 00000017416 11216135717 033175 0 ustar twerner twerner package org.apache.maven.doxia.module.fo;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Date;
import javax.xml.transform.Result;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerConfigurationException;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.sax.SAXResult;
import javax.xml.transform.stream.StreamSource;
import org.apache.fop.apps.FOPException;
import org.apache.fop.apps.FOUserAgent;
import org.apache.fop.apps.Fop;
import org.apache.fop.apps.FopFactory;
import org.apache.fop.apps.MimeConstants;
import org.apache.maven.doxia.document.DocumentModel;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
/**
* FO Sink utilities.
*
* @author ltheussl
* @version $Id: FoUtils.java 785531 2009-06-17 09:47:59Z ltheussl $
* @since 1.1
*/
public class FoUtils
{
/** To reuse the FopFactory **/
private static final FopFactory FOP_FACTORY = FopFactory.newInstance();
/** To reuse the TransformerFactory **/
private static final TransformerFactory TRANSFORMER_FACTORY = TransformerFactory.newInstance();
/**
* Converts an FO file to a PDF file using FOP.
*
* @param fo the FO file, not null.
* @param pdf the target PDF file, not null.
* @param resourceDir The base directory for relative path resolution, could be null.
* If null, defaults to the parent directory of fo.
* @param documentModel the document model to add PDF metadatas like author, title and keywords, could be null.
* @throws javax.xml.transform.TransformerException In case of a conversion problem.
* @since 1.1.1
*/
public static void convertFO2PDF( File fo, File pdf, String resourceDir, DocumentModel documentModel )
throws TransformerException
{
FOUserAgent foUserAgent = getDefaultUserAgent( fo, resourceDir );
if ( documentModel != null && documentModel.getMeta() != null )
{
// http://xmlgraphics.apache.org/fop/embedding.html#user-agent
String authors = documentModel.getMeta().getAllAuthorNames();
if ( StringUtils.isNotEmpty( authors ) )
{
foUserAgent.setAuthor( authors );
}
if ( StringUtils.isNotEmpty( documentModel.getMeta().getTitle() ) )
{
foUserAgent.setTitle( documentModel.getMeta().getTitle() );
}
String keywords = documentModel.getMeta().getAllKeyWords();
if ( StringUtils.isNotEmpty( keywords ) )
{
foUserAgent.setKeywords( keywords );
}
if ( StringUtils.isNotEmpty( documentModel.getMeta().getCreator() ) )
{
foUserAgent.setCreator( documentModel.getMeta().getCreator() );
}
if ( StringUtils.isNotEmpty( documentModel.getMeta().getGenerator() ) )
{
foUserAgent.setProducer( documentModel.getMeta().getGenerator() );
}
if ( documentModel.getMeta().getCreationDate() != null )
{
foUserAgent.setCreationDate( documentModel.getMeta().getCreationDate() );
}
}
if ( foUserAgent.getCreator() == null )
{
foUserAgent.setCreator( System.getProperty( "user.name" ) );
}
if ( foUserAgent.getCreationDate() == null )
{
foUserAgent.setCreationDate( new Date() );
}
convertFO2PDF( fo, pdf, resourceDir, foUserAgent );
}
/**
* Converts an FO file to a PDF file using FOP.
*
* @param fo the FO file, not null.
* @param pdf the target PDF file, not null.
* @param resourceDir The base directory for relative path resolution, could be null.
* If null, defaults to the parent directory of fo.
* @param foUserAgent the FOUserAgent to use.
* May be null, in which case a default user agent will be used.
* @throws javax.xml.transform.TransformerException In case of a conversion problem.
* @since 1.1.1
*/
public static void convertFO2PDF( File fo, File pdf, String resourceDir, FOUserAgent foUserAgent )
throws TransformerException
{
FOUserAgent userAgent = ( foUserAgent == null ? getDefaultUserAgent( fo, resourceDir ) : foUserAgent );
OutputStream out = null;
try
{
try
{
out = new BufferedOutputStream( new FileOutputStream( pdf ) );
}
catch ( IOException e )
{
throw new TransformerException( e );
}
Result res = null;
try
{
Fop fop = FOP_FACTORY.newFop( MimeConstants.MIME_PDF, userAgent, out );
res = new SAXResult( fop.getDefaultHandler() );
}
catch ( FOPException e )
{
throw new TransformerException( e );
}
Transformer transformer = null;
try
{
// identity transformer
transformer = TRANSFORMER_FACTORY.newTransformer();
}
catch ( TransformerConfigurationException e )
{
throw new TransformerException( e );
}
transformer.transform( new StreamSource( fo ), res );
}
finally
{
IOUtil.close( out );
}
}
/**
* Converts an FO file to a PDF file using FOP.
*
* @param fo the FO file, not null.
* @param pdf the target PDF file, not null.
* @param resourceDir The base directory for relative path resolution, could be null.
* If null, defaults to the parent directory of fo.
* @throws javax.xml.transform.TransformerException In case of a conversion problem.
* @see #convertFO2PDF(File, File, String, DocumentModel)
*/
public static void convertFO2PDF( File fo, File pdf, String resourceDir )
throws TransformerException
{
convertFO2PDF( fo, pdf, resourceDir, (DocumentModel) null );
}
/**
* Returns a base URL to be used by the FOUserAgent.
*
* @param fo the FO file.
* @param resourceDir the resource directory.
* @return String.
*/
private static String getBaseURL( File fo, String resourceDir )
{
String url = null;
if ( resourceDir == null )
{
url = "file:///" + fo.getParent() + "/";
}
else
{
url = "file:///" + resourceDir + "/";
}
return url;
}
private static FOUserAgent getDefaultUserAgent( File fo, String resourceDir )
{
FOUserAgent foUserAgent = FOP_FACTORY.newFOUserAgent();
foUserAgent.setBaseURL( getBaseURL( fo, resourceDir ) );
return foUserAgent;
}
private FoUtils()
{
// Utility class
}
}
././@LongLink 0000000 0000000 0000000 00000000145 00000000000 011565 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java doxia-1.1.4/doxia-modules/doxia-module-fo/src/main/java/org/apache/maven/doxia/module/fo/FoSink.java0000644 0001750 0001750 00000136522 11251210250 033123 0 ustar twerner twerner package org.apache.maven.doxia.module.fo;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
import java.util.Stack;
import java.util.TreeSet;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.html.HTML.Attribute;
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.sink.AbstractXmlSink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.SinkUtils;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
/**
* A Doxia Sink that produces a FO model. The usage is similar to the following:
*
*
*
* @param length a double.
* @param unit a int.
* @return a int.
*/
protected int toTwips( double length, int unit )
{
double points;
switch ( unit )
{
case UNIT_MILLIMETER:
points = ( length / 25.4 ) * 72.;
break;
case UNIT_CENTIMETER:
points = ( length / 2.54 ) * 72.;
break;
case UNIT_INCH:
points = length * 72.;
break;
case UNIT_PIXEL:
default:
points = ( length / resolution ) * 72.;
break;
}
return (int) Math.rint( points * 20. );
}
/** {@inheritDoc} */
public void title()
{
Paragraph p = new Paragraph( STYLE_BOLD, fontSize + 6 );
p.justification = Sink.JUSTIFY_CENTER;
beginParagraph( p );
emptyHeader = false;
}
/** {@inheritDoc} */
public void title_()
{
endParagraph();
}
/** {@inheritDoc} */
public void author()
{
Paragraph p = new Paragraph( STYLE_ROMAN, fontSize + 2 );
p.justification = Sink.JUSTIFY_CENTER;
beginParagraph( p );
emptyHeader = false;
}
/** {@inheritDoc} */
public void author_()
{
endParagraph();
}
/** {@inheritDoc} */
public void date()
{
Paragraph p = new Paragraph( STYLE_ROMAN, fontSize );
p.justification = Sink.JUSTIFY_CENTER;
beginParagraph( p );
emptyHeader = false;
}
/** {@inheritDoc} */
public void date_()
{
endParagraph();
}
/** {@inheritDoc} */
public void body()
{
// nop
}
/** {@inheritDoc} */
public void body_()
{
writer.println( "}" );
writer.flush();
}
/** {@inheritDoc} */
public void section1()
{
sectionLevel = 1;
}
/** {@inheritDoc} */
public void section1_()
{
// nop
}
/** {@inheritDoc} */
public void section2()
{
sectionLevel = 2;
}
/** {@inheritDoc} */
public void section2_()
{
// nop
}
/** {@inheritDoc} */
public void section3()
{
sectionLevel = 3;
}
/** {@inheritDoc} */
public void section3_()
{
// nop
}
/** {@inheritDoc} */
public void section4()
{
sectionLevel = 4;
}
/** {@inheritDoc} */
public void section4_()
{
// nop
}
/** {@inheritDoc} */
public void section5()
{
sectionLevel = 5;
}
/** {@inheritDoc} */
public void section5_()
{
// nop
}
/** {@inheritDoc} */
public void sectionTitle()
{
int stl = STYLE_BOLD;
int size = fontSize;
switch ( sectionLevel )
{
case 1:
size = fontSize + 6;
break;
case 2:
size = fontSize + 4;
break;
case 3:
size = fontSize + 2;
break;
case 4:
break;
case 5:
stl = STYLE_ROMAN;
break;
}
Paragraph p = new Paragraph( stl, size );
p.style = styleNumber( sectionLevel );
beginParagraph( p );
}
/** {@inheritDoc} */
public void sectionTitle_()
{
endParagraph();
}
private int styleNumber( int level )
{
return level;
}
/** {@inheritDoc} */
public void list()
{
indentation.add( LIST_INDENT );
space.set( space.get() / 2 );
}
/** {@inheritDoc} */
public void list_()
{
indentation.restore();
space.restore();
}
/** {@inheritDoc} */
public void listItem()
{
Paragraph p = new Paragraph();
p.leftIndent = indentation.get() + listItemIndent;
p.firstLineIndent = ( -listItemIndent );
beginParagraph( p );
beginStyle( STYLE_BOLD );
writer.println( LIST_ITEM_HEADER );
endStyle();
indentation.add( listItemIndent );
space.set( space.get() / 2 );
}
/** {@inheritDoc} */
public void listItem_()
{
endParagraph();
indentation.restore();
space.restore();
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
this.numbering.addElement( new Integer( numbering ) );
itemNumber.addElement( new Counter( 0 ) );
indentation.add( LIST_INDENT );
space.set( space.get() / 2 );
}
/** {@inheritDoc} */
public void numberedList_()
{
numbering.removeElementAt( numbering.size() - 1 );
itemNumber.removeElementAt( itemNumber.size() - 1 );
indentation.restore();
space.restore();
}
/** {@inheritDoc} */
public void numberedListItem()
{
( (Counter) itemNumber.lastElement() ).increment();
int indent = 0;
String header = getItemHeader();
Font font = getFont( STYLE_TYPEWRITER, fontSize );
if ( font != null )
{
indent = textWidth( header, font );
}
Paragraph p = new Paragraph();
p.leftIndent = indentation.get() + indent;
p.firstLineIndent = ( -indent );
beginParagraph( p );
beginStyle( STYLE_TYPEWRITER );
writer.println( header );
endStyle();
indentation.add( indent );
space.set( space.get() / 2 );
}
/** {@inheritDoc} */
public void numberedListItem_()
{
endParagraph();
indentation.restore();
space.restore();
}
private String getItemHeader()
{
int nmb = ( (Integer) this.numbering.lastElement() ).intValue();
int iNmb = ( (Counter) this.itemNumber.lastElement() ).get();
StringBuffer buf = new StringBuffer();
switch ( nmb )
{
case Sink.NUMBERING_DECIMAL:
default:
buf.append( iNmb );
buf.append( ". " );
while ( buf.length() < 4 )
{
buf.append( ' ' );
}
break;
case Sink.NUMBERING_LOWER_ALPHA:
buf.append( AlphaNumerals.toString( iNmb, true ) );
buf.append( ") " );
break;
case Sink.NUMBERING_UPPER_ALPHA:
buf.append( AlphaNumerals.toString( iNmb, false ) );
buf.append( ". " );
break;
case Sink.NUMBERING_LOWER_ROMAN:
buf.append( RomanNumerals.toString( iNmb, true ) );
buf.append( ") " );
while ( buf.length() < 6 )
{
buf.append( ' ' );
}
break;
case Sink.NUMBERING_UPPER_ROMAN:
buf.append( RomanNumerals.toString( iNmb, false ) );
buf.append( ". " );
while ( buf.length() < 6 )
{
buf.append( ' ' );
}
break;
}
return buf.toString();
}
/** {@inheritDoc} */
public void definitionList()
{
int next = space.getNext();
indentation.add( LIST_INDENT );
space.set( space.get() / 2 );
space.setNext( next );
}
/** {@inheritDoc} */
public void definitionList_()
{
indentation.restore();
space.restore();
}
/** {@inheritDoc} */
public void definitionListItem()
{
int next = space.getNext();
space.set( space.get() / 2 );
space.setNext( next );
}
/** {@inheritDoc} */
public void definitionListItem_()
{
space.restore();
}
/** {@inheritDoc} */
public void definedTerm()
{
// nop
}
/** {@inheritDoc} */
public void definedTerm_()
{
endParagraph();
}
/** {@inheritDoc} */
public void definition()
{
int next = space.getNext();
indentation.add( DEFINITION_INDENT );
space.set( space.get() / 2 );
space.setNext( next );
}
/** {@inheritDoc} */
public void definition_()
{
endParagraph();
indentation.restore();
space.restore();
}
/** {@inheritDoc} */
public void table()
{
// nop
}
/** {@inheritDoc} */
public void table_()
{
// nop
}
/** {@inheritDoc} */
public void tableRows( int[] justification, boolean grid )
{
table = new Table( justification, grid );
context.set( CONTEXT_TABLE );
}
/** {@inheritDoc} */
public void tableRows_()
{
boolean bb = false;
boolean br = false;
int offset = ( pageWidth() - ( table.width() + indentation.get() ) ) / 2;
int x0 = indentation.get() + offset;
space.skip();
for ( int i = 0; i < table.rows.size(); ++i )
{
Row r = (Row) table.rows.elementAt( i );
writer.print( "\\trowd" );
writer.print( "\\trleft" + x0 );
writer.print( "\\trgaph" + CELL_HORIZONTAL_PAD );
writer.println( "\\trrh" + r.height() );
if ( table.grid )
{
if ( i == ( table.rows.size() - 1 ) )
{
bb = true;
}
br = false;
}
for ( int j = 0, x = x0; j < table.numColumns; ++j )
{
if ( table.grid )
{
if ( j == ( table.numColumns - 1 ) )
{
br = true;
}
setBorder( true, bb, true, br );
x += BORDER_WIDTH;
}
x += table.columnWidths[j];
writer.println( "\\clvertalc\\cellx" + x );
}
for ( int j = 0; j < table.numColumns; ++j )
{
if ( j >= r.cells.size() )
{
break;
}
Cell c = (Cell) r.cells.elementAt( j );
writer.print( "\\pard\\intbl" );
setJustification( table.justification[j] );
writer.println( "\\plain\\f0\\fs" + ( 2 * fontSize ) );
for ( int k = 0; k < c.lines.size(); ++k )
{
if ( k > 0 )
{
writer.println( "\\line" );
}
Line l = (Line) c.lines.elementAt( k );
for ( int n = 0; n < l.items.size(); ++n )
{
Item item = (Item) l.items.elementAt( n );
writer.print( "{" );
setStyle( item.style );
writer.println( escape( item.text ) );
writer.println( "}" );
}
}
writer.println( "\\cell" );
}
writer.println( "\\row" );
}
context.restore();
}
private int pageWidth()
{
double width = paperWidth - ( leftMargin + rightMargin );
return toTwips( width, UNIT_CENTIMETER );
}
private void setBorder( boolean bt, boolean bb, boolean bl, boolean br )
{
if ( bt )
{
writer.println( "\\clbrdrt\\brdrs\\brdrw" + BORDER_WIDTH );
}
if ( bb )
{
writer.println( "\\clbrdrb\\brdrs\\brdrw" + BORDER_WIDTH );
}
if ( bl )
{
writer.println( "\\clbrdrl\\brdrs\\brdrw" + BORDER_WIDTH );
}
if ( br )
{
writer.println( "\\clbrdrr\\brdrs\\brdrw" + BORDER_WIDTH );
}
}
private void setJustification( int justification )
{
switch ( justification )
{
case Sink.JUSTIFY_LEFT:
default:
writer.println( "\\ql" );
break;
case Sink.JUSTIFY_CENTER:
writer.println( "\\qc" );
break;
case Sink.JUSTIFY_RIGHT:
writer.println( "\\qr" );
break;
}
}
private void setStyle( int style )
{
switch ( style )
{
case STYLE_ITALIC:
writer.println( "\\i" );
break;
case STYLE_BOLD:
writer.println( "\\b" );
break;
case STYLE_TYPEWRITER:
writer.println( "\\f1" );
break;
default:
break;
}
}
/** {@inheritDoc} */
public void tableRow()
{
row = new Row();
}
/** {@inheritDoc} */
public void tableRow_()
{
table.add( row );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
tableCell();
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
tableCell_();
}
/** {@inheritDoc} */
public void tableCell()
{
cell = new Cell();
line = new Line();
}
/** {@inheritDoc} */
public void tableCell_()
{
cell.add( line );
row.add( cell );
}
/** {@inheritDoc} */
public void tableCaption()
{
Paragraph p = new Paragraph();
p.justification = Sink.JUSTIFY_CENTER;
p.spaceBefore /= 2;
beginParagraph( p );
}
/** {@inheritDoc} */
public void tableCaption_()
{
endParagraph();
}
/** {@inheritDoc} */
public void paragraph()
{
if ( paragraph == null )
{
beginParagraph( new Paragraph() );
}
}
/** {@inheritDoc} */
public void paragraph_()
{
endParagraph();
}
private void beginParagraph( Paragraph p )
{
p.begin();
this.paragraph = p;
if ( style != STYLE_ROMAN )
{
beginStyle( style );
}
}
private void endParagraph()
{
if ( paragraph != null )
{
if ( style != STYLE_ROMAN )
{
endStyle();
}
paragraph.end();
paragraph = null;
}
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
verbatim = new StringBuffer();
frame = boxed;
context.set( CONTEXT_VERBATIM );
}
/** {@inheritDoc} */
public void verbatim_()
{
String text = verbatim.toString();
Paragraph p = new Paragraph();
p.fontStyle = STYLE_TYPEWRITER;
p.frame = frame;
beginParagraph( p );
StringTokenizer t = new StringTokenizer( text, EOL, true );
while ( t.hasMoreTokens() )
{
String s = t.nextToken();
if ( s.equals( EOL ) && t.hasMoreTokens() )
{
writer.println( "\\line" );
}
else
{
writer.println( escape( s ) );
}
}
endParagraph();
context.restore();
}
/** {@inheritDoc} */
public void figure()
{
// nop
}
/** {@inheritDoc} */
public void figure_()
{
// nop
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
Paragraph p = new Paragraph();
p.justification = Sink.JUSTIFY_CENTER;
beginParagraph( p );
try
{
writeImage( name );
}
catch ( Exception e )
{
getLog().error( e.getMessage(), e );
}
endParagraph();
}
private void writeImage( String source )
throws Exception
{
if ( !source.toLowerCase().endsWith( ".ppm" ) )
{
// TODO support more image types!
String msg =
"Unsupported image type for image file: '" + source + "'. Only PPM image type is "
+ "currently supported.";
logMessage( "unsupportedImage", msg );
return;
}
int bytesPerLine;
PBMReader ppm = new PBMReader( source );
WMFWriter.Dib dib = new WMFWriter.Dib();
WMFWriter wmf = new WMFWriter();
int srcWidth = ppm.width();
int srcHeight = ppm.height();
dib.biWidth = srcWidth;
dib.biHeight = srcHeight;
dib.biXPelsPerMeter = (int) ( resolution * 100. / 2.54 );
dib.biYPelsPerMeter = dib.biXPelsPerMeter;
if ( imageType.equals( IMG_TYPE_RGB ) )
{
dib.biBitCount = 24;
dib.biCompression = WMFWriter.Dib.BI_RGB; // no compression
bytesPerLine = 4 * ( ( 3 * srcWidth + 3 ) / 4 );
dib.bitmap = new byte[srcHeight * bytesPerLine];
byte[] l = new byte[3 * srcWidth];
for ( int i = ( srcHeight - 1 ); i >= 0; --i )
{
ppm.read( l, 0, l.length );
for ( int j = 0, k = ( i * bytesPerLine ); j < l.length; j += 3 )
{
// component order = BGR
dib.bitmap[k++] = l[j + 2];
dib.bitmap[k++] = l[j + 1];
dib.bitmap[k++] = l[j];
}
}
}
else
{
dib.biBitCount = 8;
bytesPerLine = 4 * ( ( srcWidth + 3 ) / 4 );
byte[] bitmap = new byte[srcHeight * bytesPerLine];
Vector colors = new Vector( 256 );
colors.addElement( Color.white );
colors.addElement( Color.black );
byte[] l = new byte[3 * srcWidth];
for ( int i = ( srcHeight - 1 ); i >= 0; --i )
{
ppm.read( l, 0, l.length );
for ( int j = 0, k = ( i * bytesPerLine ); j < l.length; )
{
int r = (int) l[j++] & 0xff;
int g = (int) l[j++] & 0xff;
int b = (int) l[j++] & 0xff;
Color color = new Color( r, g, b );
int index = colors.indexOf( color );
if ( index < 0 )
{
if ( colors.size() < colors.capacity() )
{
colors.addElement( color );
index = colors.size() - 1;
}
else
{
index = 1;
}
}
bitmap[k++] = (byte) index;
}
}
dib.biClrUsed = colors.size();
dib.biClrImportant = dib.biClrUsed;
dib.palette = new byte[4 * dib.biClrUsed];
for ( int i = 0, j = 0; i < dib.biClrUsed; ++i, ++j )
{
Color color = (Color) colors.elementAt( i );
dib.palette[j++] = (byte) color.getBlue();
dib.palette[j++] = (byte) color.getGreen();
dib.palette[j++] = (byte) color.getRed();
}
if ( imageCompression )
{
dib.biCompression = WMFWriter.Dib.BI_RLE8;
dib.bitmap = new byte[bitmap.length + ( 2 * ( bitmap.length / 255 + 1 ) )];
dib.biSizeImage = WMFWriter.Dib.rlEncode8( bitmap, 0, bitmap.length, dib.bitmap, 0 );
}
else
{
dib.biCompression = WMFWriter.Dib.BI_RGB;
dib.bitmap = bitmap;
}
}
if ( imageFormat.equals( IMG_FORMAT_WMF ) )
{
int[] parameters;
WMFWriter.Record record;
/*
* See the libwmf library documentation
* (http://www.wvware.com/wmf_doc_index.html)
* for a description of WMF records.
*/
// set mapping mode to MM_TEXT (logical unit = pixel)
parameters = new int[1];
parameters[0] = 1;
record = new WMFWriter.Record( 0x0103, parameters );
wmf.add( record );
// set window origin and dimensions
parameters = new int[2];
record = new WMFWriter.Record( 0x020b, parameters );
wmf.add( record );
parameters = new int[2];
parameters[0] = srcHeight;
parameters[1] = srcWidth;
record = new WMFWriter.Record( 0x020c, parameters );
wmf.add( record );
parameters = new int[WMFWriter.DibBitBltRecord.P_COUNT];
// raster operation = SRCCOPY (0x00cc0020)
parameters[WMFWriter.DibBitBltRecord.P_ROP_H] = 0x00cc;
parameters[WMFWriter.DibBitBltRecord.P_ROP_L] = 0x0020;
parameters[WMFWriter.DibBitBltRecord.P_WIDTH] = srcWidth;
parameters[WMFWriter.DibBitBltRecord.P_HEIGHT] = srcHeight;
record = new WMFWriter.DibBitBltRecord( parameters, dib );
wmf.add( record );
}
if ( imageFormat.equals( IMG_FORMAT_WMF ) )
{
writer.print( "{\\pict\\wmetafile1" );
writer.println( "\\picbmp\\picbpp" + dib.biBitCount );
}
else
{
writer.print( "{\\pict\\dibitmap0\\wbmplanes1" );
writer.print( "\\wbmbitspixel" + dib.biBitCount );
writer.println( "\\wbmwidthbytes" + bytesPerLine );
}
writer.print( "\\picw" + srcWidth );
writer.print( "\\pich" + srcHeight );
writer.print( "\\picwgoal" + toTwips( srcWidth, UNIT_PIXEL ) );
writer.println( "\\pichgoal" + toTwips( srcHeight, UNIT_PIXEL ) );
if ( imageFormat.equals( IMG_FORMAT_WMF ) )
{
if ( imageDataFormat.equals( IMG_DATA_RAW ) )
{
writer.print( "\\bin" + ( 2 * wmf.size() ) + " " );
writer.flush();
wmf.write( stream );
stream.flush();
}
else
{
wmf.print( writer );
}
}
else
{
if ( imageDataFormat.equals( IMG_DATA_RAW ) )
{
writer.print( "\\bin" + ( 2 * dib.size() ) + " " );
writer.flush();
dib.write( stream );
stream.flush();
}
else
{
dib.print( writer );
}
}
writer.println( "}" );
}
/** {@inheritDoc} */
public void figureCaption()
{
Paragraph p = new Paragraph();
p.justification = Sink.JUSTIFY_CENTER;
p.spaceBefore /= 2;
beginParagraph( p );
}
/** {@inheritDoc} */
public void figureCaption_()
{
endParagraph();
}
/** {@inheritDoc} */
public void horizontalRule()
{
writer.print( "\\pard\\li" + indentation.get() );
int skip = space.getNext();
if ( skip > 0 )
{
writer.print( "\\sb" + skip );
}
space.setNext( skip );
writer.print( "\\brdrb\\brdrs\\brdrw" + BORDER_WIDTH );
writer.println( "\\plain\\fs1\\par" );
}
/** {@inheritDoc} */
public void pageBreak()
{
writer.println( "\\page" );
}
/** {@inheritDoc} */
public void anchor( String name )
{
// nop
}
/** {@inheritDoc} */
public void anchor_()
{
// nop
}
/** {@inheritDoc} */
public void link( String name )
{
// nop
}
/** {@inheritDoc} */
public void link_()
{
// nop
}
/** {@inheritDoc} */
public void italic()
{
beginStyle( STYLE_ITALIC );
}
/** {@inheritDoc} */
public void italic_()
{
endStyle();
}
/** {@inheritDoc} */
public void bold()
{
beginStyle( STYLE_BOLD );
}
/** {@inheritDoc} */
public void bold_()
{
endStyle();
}
/** {@inheritDoc} */
public void monospaced()
{
beginStyle( STYLE_TYPEWRITER );
}
/** {@inheritDoc} */
public void monospaced_()
{
endStyle();
}
private void beginStyle( int style )
{
this.style = style;
switch ( context.get() )
{
case CONTEXT_TABLE:
break;
default:
if ( paragraph != null )
{
switch ( style )
{
case STYLE_ITALIC:
writer.println( "{\\i" );
break;
case STYLE_BOLD:
writer.println( "{\\b" );
break;
case STYLE_TYPEWRITER:
writer.println( "{\\f1" );
break;
default:
writer.println( "{" );
break;
}
}
break;
}
}
private void endStyle()
{
style = STYLE_ROMAN;
switch ( context.get() )
{
case CONTEXT_TABLE:
break;
default:
if ( paragraph != null )
{
writer.println( "}" );
}
break;
}
}
/** {@inheritDoc} */
public void lineBreak()
{
switch ( context.get() )
{
case CONTEXT_TABLE:
cell.add( line );
line = new Line();
break;
default:
writer.println( "\\line" );
break;
}
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
switch ( context.get() )
{
case CONTEXT_TABLE:
line.add( new Item( style, " " ) );
break;
default:
writer.println( "\\~" );
break;
}
}
/** {@inheritDoc} */
public void text( String text )
{
switch ( context.get() )
{
case CONTEXT_VERBATIM:
verbatim.append( text );
break;
case CONTEXT_TABLE:
StringTokenizer t = new StringTokenizer( text, EOL, true );
while ( t.hasMoreTokens() )
{
String token = t.nextToken();
if ( token.equals( EOL ) )
{
cell.add( line );
line = new Line();
}
else
{
line.add( new Item( style, normalize( token ) ) );
}
}
break;
default:
if ( paragraph == null )
{
beginParagraph( new Paragraph() );
}
writer.println( escape( normalize( text ) ) );
}
}
/**
* {@inheritDoc}
*
* Unkown events just log a warning message but are ignored otherwise.
* @see org.apache.maven.doxia.sink.Sink#unknown(String,Object[],SinkEventAttributes)
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
String msg = "Unknown Sink event: '" + name + "', ignoring!";
logMessage( "unknownEvent", msg );
}
private static String normalize( String s )
{
int length = s.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = s.charAt( i );
if ( Character.isWhitespace( c ) )
{
if ( buffer.length() == 0 || buffer.charAt( buffer.length() - 1 ) != ' ' )
{
buffer.append( ' ' );
}
}
else
{
buffer.append( c );
}
}
return buffer.toString();
}
private static String escape( String s )
{
int length = s.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = s.charAt( i );
switch ( c )
{
case '\\':
buffer.append( "\\\\" );
break;
case '{':
buffer.append( "\\{" );
break;
case '}':
buffer.append( "\\}" );
break;
default:
buffer.append( c );
}
}
return buffer.toString();
}
/**
*
getFont.
*
* @param style a int.
* @param size a int.
* @return a {@link org.apache.maven.doxia.module.rtf.Font} object.
*/
protected Font getFont( int style, int size )
{
Font font = null;
StringBuffer buf = new StringBuffer();
buf.append( style );
buf.append( size );
String key = buf.toString();
Object object = fontTable.get( key );
if ( object == null )
{
try
{
font = new Font( style, size );
fontTable.put( key, font );
}
catch ( Exception ignored )
{
if ( getLog().isDebugEnabled() )
{
getLog().debug( ignored.getMessage(), ignored );
}
}
}
else
{
font = (Font) object;
}
return font;
}
private static int textWidth( String text, Font font )
{
int width = 0;
StringTokenizer t = new StringTokenizer( text, EOL );
while ( t.hasMoreTokens() )
{
int w = font.textExtents( t.nextToken() ).width;
if ( w > width )
{
width = w;
}
}
return width;
}
/** {@inheritDoc} */
public void flush()
{
writer.flush();
}
/** {@inheritDoc} */
public void close()
{
writer.close();
if ( getLog().isWarnEnabled() && this.warnMessages != null )
{
for ( Iterator it = this.warnMessages.entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
Set set = (Set) entry.getValue();
for ( Iterator it2 = set.iterator(); it2.hasNext(); )
{
String msg = (String) it2.next();
getLog().warn( msg );
}
}
this.warnMessages = null;
}
init();
}
/**
* If debug mode is enabled, log the msg as is, otherwise add unique msg in warnMessages.
*
* @param key not null
* @param msg not null
* @see #close()
* @since 1.1.1
*/
private void logMessage( String key, String msg )
{
msg = "[RTF Sink] " + msg;
if ( getLog().isDebugEnabled() )
{
getLog().debug( msg );
return;
}
if ( warnMessages == null )
{
warnMessages = new HashMap();
}
Set set = (Set) warnMessages.get( key );
if ( set == null )
{
set = new TreeSet();
}
set.add( msg );
warnMessages.put( key, set );
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.fontTable.clear();
this.context = new Context();
this.paragraph = null;
this.indentation = new Indentation( 0 );
this.space = new Space( 20 * DEFAULT_SPACING );
Font font = getFont( STYLE_BOLD, fontSize );
if ( font != null )
{
this.listItemIndent = textWidth( LIST_ITEM_HEADER, font );
}
this.numbering.clear();
this.itemNumber.clear();
this.style = STYLE_ROMAN;
this.sectionLevel = 0;
this.emptyHeader = false;
this.verbatim = null;
this.frame = false;
this.table = null;
this.row = null;
this.cell = null;
this.line = null;
this.warnMessages = null;
}
// -----------------------------------------------------------------------
static class Counter
{
private int value;
Counter( int value )
{
set( value );
}
void set( int value )
{
this.value = value;
}
int get()
{
return value;
}
void increment()
{
increment( 1 );
}
void increment( int value )
{
this.value += value;
}
}
static class Context
{
private int context = CONTEXT_UNDEFINED;
private Vector stack = new Vector();
void set( int context )
{
stack.addElement( new Integer( this.context ) );
this.context = context;
}
void restore()
{
if ( !stack.isEmpty() )
{
context = ( (Integer) stack.lastElement() ).intValue();
stack.removeElementAt( stack.size() - 1 );
}
}
int get()
{
return context;
}
}
class Paragraph
{
int style = 0;
int justification = Sink.JUSTIFY_LEFT;
int leftIndent = indentation.get();
int rightIndent = 0;
int firstLineIndent = 0;
int spaceBefore = space.getNext();
int spaceAfter = 0;
boolean frame = false;
int fontStyle = STYLE_ROMAN;
int fontSize = RtfSink.this.fontSize;
Paragraph()
{
// nop
}
Paragraph( int style, int size )
{
fontStyle = style;
fontSize = size;
}
void begin()
{
writer.print( "\\pard" );
if ( style > 0 )
{
writer.print( "\\s" + style );
}
switch ( justification )
{
case Sink.JUSTIFY_LEFT:
default:
break;
case Sink.JUSTIFY_CENTER:
writer.print( "\\qc" );
break;
case Sink.JUSTIFY_RIGHT:
writer.print( "\\qr" );
break;
}
if ( leftIndent != 0 )
{
writer.print( "\\li" + leftIndent );
}
if ( rightIndent != 0 )
{
writer.print( "\\ri" + rightIndent );
}
if ( firstLineIndent != 0 )
{
writer.print( "\\fi" + firstLineIndent );
}
if ( spaceBefore != 0 )
{
writer.print( "\\sb" + spaceBefore );
}
if ( spaceAfter != 0 )
{
writer.print( "\\sa" + spaceAfter );
}
if ( frame )
{
writer.print( "\\box\\brdrs\\brdrw" + BORDER_WIDTH );
}
writer.print( "\\plain" );
switch ( fontStyle )
{
case STYLE_ROMAN:
default:
writer.print( "\\f0" );
break;
case STYLE_ITALIC:
writer.print( "\\f0\\i" );
break;
case STYLE_BOLD:
writer.print( "\\f0\\b" );
break;
case STYLE_TYPEWRITER:
writer.print( "\\f1" );
break;
}
writer.println( "\\fs" + ( 2 * fontSize ) );
}
void end()
{
writer.println( "\\par" );
}
}
class Space
{
private int space;
private int next;
private Vector stack = new Vector();
Space( int space /*twips*/ )
{
this.space = space;
next = space;
}
void set( int space /*twips*/ )
{
stack.addElement( new Integer( this.space ) );
this.space = space;
next = space;
}
int get()
{
return space;
}
void restore()
{
if ( !stack.isEmpty() )
{
space = ( (Integer) stack.lastElement() ).intValue();
stack.removeElementAt( stack.size() - 1 );
next = space;
}
}
void setNext( int space /*twips*/ )
{
next = space;
}
int getNext()
{
int nxt = this.next;
this.next = space;
return nxt;
}
void skip()
{
skip( getNext() );
}
void skip( int space /*twips*/ )
{
writer.print( "\\pard" );
if ( ( space -= 10 ) > 0 )
{
writer.print( "\\sb" + space );
}
writer.println( "\\plain\\fs1\\par" );
}
}
static class Indentation
{
private int indent;
private Vector stack = new Vector();
Indentation( int indent /*twips*/ )
{
this.indent = indent;
}
void set( int indent /*twips*/ )
{
stack.addElement( new Integer( this.indent ) );
this.indent = indent;
}
int get()
{
return indent;
}
void restore()
{
if ( !stack.isEmpty() )
{
indent = ( (Integer) stack.lastElement() ).intValue();
stack.removeElementAt( stack.size() - 1 );
}
}
void add( int indent /*twips*/ )
{
set( this.indent + indent );
}
}
static class Table
{
int numColumns;
int[] columnWidths;
int[] justification;
boolean grid;
Vector rows;
Table( int[] justification, boolean grid )
{
numColumns = justification.length;
columnWidths = new int[numColumns];
this.justification = justification;
this.grid = grid;
rows = new Vector();
}
void add( Row row )
{
rows.addElement( row );
for ( int i = 0; i < numColumns; ++i )
{
if ( i >= row.cells.size() )
{
break;
}
Cell cell = (Cell) row.cells.elementAt( i );
int width = cell.boundingBox().width;
if ( width > columnWidths[i] )
{
columnWidths[i] = width;
}
}
}
int width()
{
int width = 0;
for ( int i = 0; i < numColumns; ++i )
{
width += columnWidths[i];
}
if ( grid )
{
width += ( numColumns + 1 ) * BORDER_WIDTH;
}
return width;
}
}
static class Row
{
Vector cells = new Vector();
void add( Cell cell )
{
cells.addElement( cell );
}
int height()
{
int height = 0;
int numCells = cells.size();
for ( int i = 0; i < numCells; ++i )
{
Cell cell = (Cell) cells.elementAt( i );
Box box = cell.boundingBox();
if ( box.height > height )
{
height = box.height;
}
}
return height;
}
}
class Cell
{
Vector lines = new Vector();
void add( Line line )
{
lines.addElement( line );
}
Box boundingBox()
{
int width = 0;
int height = 0;
for ( int i = 0; i < lines.size(); ++i )
{
int w = 0;
int h = 0;
Line line = (Line) lines.elementAt( i );
for ( int j = 0; j < line.items.size(); ++j )
{
Item item = (Item) line.items.elementAt( j );
Font font = getFont( item.style, fontSize );
if ( font == null )
{
continue;
}
Font.TextExtents x = font.textExtents( item.text );
w += x.width;
if ( x.height > h )
{
h = x.height;
}
}
if ( w > width )
{
width = w;
}
height += h;
}
width += ( 2 * CELL_HORIZONTAL_PAD );
height += ( 2 * CELL_VERTICAL_PAD );
// allow one more pixel for grid outline
width += toTwips( 1., UNIT_PIXEL );
return new Box( width, height );
}
}
static class Line
{
Vector items = new Vector();
void add( Item item )
{
items.addElement( item );
}
}
static class Item
{
int style;
String text;
Item( int style, String text )
{
this.style = style;
this.text = text;
}
}
static class Box
{
int width;
int height;
Box( int width, int height )
{
this.width = width;
this.height = height;
}
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-rtf/src/main/java/org/apache/maven/doxia/module/rtf/MonospaceBold.java doxia-1.1.4/doxia-modules/doxia-module-rtf/src/main/java/org/apache/maven/doxia/module/rtf/Monospace0000644 0001750 0001750 00000032303 10767707462 033337 0 ustar twerner twerner package org.apache.maven.doxia.module.rtf;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* @version $Id: MonospaceBold.java 638290 2008-03-18 09:45:22Z bentmann $
*/
class MonospaceBold
extends FontMetrics
{
static final CharMetrics[] metrics = {new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 202, -15, 398, 572 ), new CharMetrics( 600, 0, 135, 277, 465, 562 ),
new CharMetrics( 600, 0, 56, -45, 544, 651 ), new CharMetrics( 600, 0, 82, -126, 519, 666 ),
new CharMetrics( 600, 0, 5, -15, 595, 616 ), new CharMetrics( 600, 0, 36, -15, 546, 543 ),
new CharMetrics( 600, 0, 171, 277, 423, 562 ), new CharMetrics( 600, 0, 219, -102, 461, 616 ),
new CharMetrics( 600, 0, 139, -102, 381, 616 ), new CharMetrics( 600, 0, 91, 219, 509, 601 ),
new CharMetrics( 600, 0, 71, 39, 529, 478 ), new CharMetrics( 600, 0, 123, -111, 393, 174 ),
new CharMetrics( 600, 0, 100, 203, 500, 313 ), new CharMetrics( 600, 0, 192, -15, 408, 171 ),
new CharMetrics( 600, 0, 98, -77, 502, 626 ), new CharMetrics( 600, 0, 87, -15, 513, 616 ),
new CharMetrics( 600, 0, 81, 0, 539, 616 ), new CharMetrics( 600, 0, 61, 0, 499, 616 ),
new CharMetrics( 600, 0, 63, -15, 501, 616 ), new CharMetrics( 600, 0, 53, 0, 507, 616 ),
new CharMetrics( 600, 0, 70, -15, 521, 601 ), new CharMetrics( 600, 0, 90, -15, 521, 616 ),
new CharMetrics( 600, 0, 55, 0, 494, 601 ), new CharMetrics( 600, 0, 83, -15, 517, 616 ),
new CharMetrics( 600, 0, 79, -15, 510, 616 ), new CharMetrics( 600, 0, 191, -15, 407, 425 ),
new CharMetrics( 600, 0, 123, -111, 408, 425 ), new CharMetrics( 600, 0, 66, 15, 523, 501 ),
new CharMetrics( 600, 0, 71, 118, 529, 398 ), new CharMetrics( 600, 0, 77, 15, 534, 501 ),
new CharMetrics( 600, 0, 98, -14, 501, 580 ), new CharMetrics( 600, 0, 16, -15, 584, 616 ),
new CharMetrics( 600, 0, -9, 0, 609, 562 ), new CharMetrics( 600, 0, 30, 0, 573, 562 ),
new CharMetrics( 600, 0, 22, -18, 560, 580 ), new CharMetrics( 600, 0, 30, 0, 594, 562 ),
new CharMetrics( 600, 0, 25, 0, 560, 562 ), new CharMetrics( 600, 0, 39, 0, 570, 562 ),
new CharMetrics( 600, 0, 22, -18, 594, 580 ), new CharMetrics( 600, 0, 20, 0, 580, 562 ),
new CharMetrics( 600, 0, 77, 0, 523, 562 ), new CharMetrics( 600, 0, 37, -18, 601, 562 ),
new CharMetrics( 600, 0, 21, 0, 599, 562 ), new CharMetrics( 600, 0, 39, 0, 578, 562 ),
new CharMetrics( 600, 0, -2, 0, 602, 562 ), new CharMetrics( 600, 0, 8, -12, 610, 562 ),
new CharMetrics( 600, 0, 22, -18, 578, 580 ), new CharMetrics( 600, 0, 48, 0, 559, 562 ),
new CharMetrics( 600, 0, 32, -138, 578, 580 ), new CharMetrics( 600, 0, 24, 0, 599, 562 ),
new CharMetrics( 600, 0, 47, -22, 553, 582 ), new CharMetrics( 600, 0, 21, 0, 579, 562 ),
new CharMetrics( 600, 0, 4, -18, 596, 562 ), new CharMetrics( 600, 0, -13, 0, 613, 562 ),
new CharMetrics( 600, 0, -18, 0, 618, 562 ), new CharMetrics( 600, 0, 12, 0, 588, 562 ),
new CharMetrics( 600, 0, 12, 0, 589, 562 ), new CharMetrics( 600, 0, 62, 0, 539, 562 ),
new CharMetrics( 600, 0, 245, -102, 475, 616 ), new CharMetrics( 600, 0, 99, -77, 503, 626 ),
new CharMetrics( 600, 0, 125, -102, 355, 616 ), new CharMetrics( 600, 0, 108, 250, 492, 616 ),
new CharMetrics( 600, 0, 0, -125, 600, -75 ), new CharMetrics( 600, 0, 178, 277, 428, 562 ),
new CharMetrics( 600, 0, 35, -15, 570, 454 ), new CharMetrics( 600, 0, 0, -15, 584, 626 ),
new CharMetrics( 600, 0, 40, -15, 545, 459 ), new CharMetrics( 600, 0, 20, -15, 591, 626 ),
new CharMetrics( 600, 0, 40, -15, 563, 454 ), new CharMetrics( 600, 0, 83, 0, 547, 626 ),
new CharMetrics( 600, 0, 30, -146, 580, 454 ), new CharMetrics( 600, 0, 5, 0, 592, 626 ),
new CharMetrics( 600, 0, 77, 0, 523, 658 ), new CharMetrics( 600, 0, 63, -146, 440, 658 ),
new CharMetrics( 600, 0, 20, 0, 585, 626 ), new CharMetrics( 600, 0, 77, 0, 523, 626 ),
new CharMetrics( 600, 0, -22, 0, 626, 454 ), new CharMetrics( 600, 0, 18, 0, 592, 454 ),
new CharMetrics( 600, 0, 30, -15, 570, 454 ), new CharMetrics( 600, 0, -1, -142, 570, 454 ),
new CharMetrics( 600, 0, 20, -142, 591, 454 ), new CharMetrics( 600, 0, 47, 0, 580, 454 ),
new CharMetrics( 600, 0, 68, -17, 535, 459 ), new CharMetrics( 600, 0, 47, -15, 532, 562 ),
new CharMetrics( 600, 0, -1, -15, 569, 439 ), new CharMetrics( 600, 0, -1, 0, 601, 439 ),
new CharMetrics( 600, 0, -18, 0, 618, 439 ), new CharMetrics( 600, 0, 6, 0, 594, 439 ),
new CharMetrics( 600, 0, -4, -142, 601, 439 ), new CharMetrics( 600, 0, 81, 0, 520, 439 ),
new CharMetrics( 600, 0, 160, -102, 464, 616 ), new CharMetrics( 600, 0, 255, -250, 345, 750 ),
new CharMetrics( 600, 0, 136, -102, 440, 616 ), new CharMetrics( 600, 0, 71, 153, 530, 356 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 77, 0, 523, 439 ),
new CharMetrics( 600, 0, 132, 508, 395, 661 ), new CharMetrics( 600, 0, 205, 508, 468, 661 ),
new CharMetrics( 600, 0, 103, 483, 497, 657 ), new CharMetrics( 600, 0, 89, 493, 512, 636 ),
new CharMetrics( 600, 0, 88, 505, 512, 585 ), new CharMetrics( 600, 0, 83, 468, 517, 631 ),
new CharMetrics( 600, 0, 230, 485, 370, 625 ), new CharMetrics( 600, 0, 128, 485, 472, 625 ),
new CharMetrics( 600, 0, 0, 0, 0, 0 ), new CharMetrics( 600, 0, 198, 481, 402, 678 ),
new CharMetrics( 600, 0, 205, -206, 387, 0 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 68, 488, 588, 661 ), new CharMetrics( 600, 0, 169, -199, 367, 0 ),
new CharMetrics( 600, 0, 103, 493, 497, 667 ), new CharMetrics( 600, 0, 0, 0, 0, 0 ),
new CharMetrics( 600, 0, 202, -146, 398, 449 ), new CharMetrics( 600, 0, 66, -49, 518, 614 ),
new CharMetrics( 600, 0, 72, -28, 558, 611 ), new CharMetrics( 600, 0, 54, 49, 546, 517 ),
new CharMetrics( 600, 0, 10, 0, 590, 562 ), new CharMetrics( 600, 0, 255, -175, 345, 675 ),
new CharMetrics( 600, 0, 83, -70, 517, 580 ), new CharMetrics( 600, 0, 128, 485, 472, 625 ),
new CharMetrics( 600, 0, 0, -18, 600, 580 ), new CharMetrics( 600, 0, 147, 196, 453, 580 ),
new CharMetrics( 600, 0, 8, 70, 553, 446 ), new CharMetrics( 600, 0, 71, 103, 529, 413 ),
new CharMetrics( 600, 0, 100, 203, 500, 313 ), new CharMetrics( 600, 0, 0, -18, 600, 580 ),
new CharMetrics( 600, 0, 88, 505, 512, 585 ), new CharMetrics( 600, 0, 86, 243, 474, 616 ),
new CharMetrics( 600, 0, 71, 24, 529, 515 ), new CharMetrics( 600, 0, 143, 230, 436, 616 ),
new CharMetrics( 600, 0, 138, 222, 433, 616 ), new CharMetrics( 600, 0, 205, 508, 468, 661 ),
new CharMetrics( 600, 0, -1, -142, 569, 439 ), new CharMetrics( 600, 0, 6, -70, 576, 580 ),
new CharMetrics( 600, 0, 196, 165, 404, 351 ), new CharMetrics( 600, 0, 205, -206, 387, 0 ),
new CharMetrics( 600, 0, 153, 230, 447, 616 ), new CharMetrics( 600, 0, 147, 196, 453, 580 ),
new CharMetrics( 600, 0, 47, 70, 592, 446 ), new CharMetrics( 600, 0, -56, -60, 656, 661 ),
new CharMetrics( 600, 0, -47, -60, 648, 661 ), new CharMetrics( 600, 0, -47, -60, 648, 661 ),
new CharMetrics( 600, 0, 99, -146, 502, 449 ), new CharMetrics( 600, 0, -9, 0, 609, 784 ),
new CharMetrics( 600, 0, -9, 0, 609, 784 ), new CharMetrics( 600, 0, -9, 0, 609, 780 ),
new CharMetrics( 600, 0, -9, 0, 609, 759 ), new CharMetrics( 600, 0, -9, 0, 609, 748 ),
new CharMetrics( 600, 0, -9, 0, 609, 801 ), new CharMetrics( 600, 0, -29, 0, 602, 562 ),
new CharMetrics( 600, 0, 22, -206, 560, 580 ), new CharMetrics( 600, 0, 25, 0, 560, 784 ),
new CharMetrics( 600, 0, 25, 0, 560, 784 ), new CharMetrics( 600, 0, 25, 0, 560, 780 ),
new CharMetrics( 600, 0, 25, 0, 560, 748 ), new CharMetrics( 600, 0, 77, 0, 523, 784 ),
new CharMetrics( 600, 0, 77, 0, 523, 784 ), new CharMetrics( 600, 0, 77, 0, 523, 780 ),
new CharMetrics( 600, 0, 77, 0, 523, 748 ), new CharMetrics( 600, 0, 30, 0, 594, 562 ),
new CharMetrics( 600, 0, 8, -12, 610, 759 ), new CharMetrics( 600, 0, 22, -18, 578, 784 ),
new CharMetrics( 600, 0, 22, -18, 578, 784 ), new CharMetrics( 600, 0, 22, -18, 578, 780 ),
new CharMetrics( 600, 0, 22, -18, 578, 759 ), new CharMetrics( 600, 0, 22, -18, 578, 748 ),
new CharMetrics( 600, 0, 81, 39, 520, 478 ), new CharMetrics( 600, 0, 22, -22, 578, 584 ),
new CharMetrics( 600, 0, 4, -18, 596, 784 ), new CharMetrics( 600, 0, 4, -18, 596, 784 ),
new CharMetrics( 600, 0, 4, -18, 596, 780 ), new CharMetrics( 600, 0, 4, -18, 596, 748 ),
new CharMetrics( 600, 0, 12, 0, 589, 784 ), new CharMetrics( 600, 0, 48, 0, 557, 562 ),
new CharMetrics( 600, 0, 22, -15, 596, 626 ), new CharMetrics( 600, 0, 35, -15, 570, 661 ),
new CharMetrics( 600, 0, 35, -15, 570, 661 ), new CharMetrics( 600, 0, 35, -15, 570, 657 ),
new CharMetrics( 600, 0, 35, -15, 570, 636 ), new CharMetrics( 600, 0, 35, -15, 570, 625 ),
new CharMetrics( 600, 0, 35, -15, 570, 678 ), new CharMetrics( 600, 0, -4, -15, 601, 454 ),
new CharMetrics( 600, 0, 40, -206, 545, 459 ), new CharMetrics( 600, 0, 40, -15, 563, 661 ),
new CharMetrics( 600, 0, 40, -15, 563, 661 ), new CharMetrics( 600, 0, 40, -15, 563, 657 ),
new CharMetrics( 600, 0, 40, -15, 563, 625 ), new CharMetrics( 600, 0, 77, 0, 523, 661 ),
new CharMetrics( 600, 0, 77, 0, 523, 661 ), new CharMetrics( 600, 0, 63, 0, 523, 657 ),
new CharMetrics( 600, 0, 77, 0, 523, 625 ), new CharMetrics( 600, 0, 58, -27, 543, 626 ),
new CharMetrics( 600, 0, 18, 0, 592, 636 ), new CharMetrics( 600, 0, 30, -15, 570, 661 ),
new CharMetrics( 600, 0, 30, -15, 570, 661 ), new CharMetrics( 600, 0, 30, -15, 570, 657 ),
new CharMetrics( 600, 0, 30, -15, 570, 636 ), new CharMetrics( 600, 0, 30, -15, 570, 625 ),
new CharMetrics( 600, 0, 71, 16, 529, 500 ), new CharMetrics( 600, 0, 30, -24, 570, 463 ),
new CharMetrics( 600, 0, -1, -15, 569, 661 ), new CharMetrics( 600, 0, -1, -15, 569, 661 ),
new CharMetrics( 600, 0, -1, -15, 569, 657 ), new CharMetrics( 600, 0, -1, -15, 569, 625 ),
new CharMetrics( 600, 0, -4, -142, 601, 661 ), new CharMetrics( 600, 0, -14, -142, 570, 626 ),
new CharMetrics( 600, 0, -4, -142, 601, 625 )};
MonospaceBold()
{
super( true, 626, -142, new CharMetrics( 0, 0, -113, -250, 749, 801 ), metrics );
}
}
doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/ 0000755 0001750 0001750 00000000000 11632765560 022640 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/pom.xml 0000644 0001750 0001750 00000004260 11470562366 024156 0 ustar twerner twerner
4.0.0doxia-modulesorg.apache.maven.doxia1.1.4../pom.xmldoxia-module-docbook-simpleDoxia :: Simplified DocBook ModuleA Doxia module for Simplified DocBook source documents.org.codehaus.plexusplexus-utilsorg.codehaus.plexusplexus-maven-pluginsrc/main/components/components.xmltarget/generated-resources/plexus/META-INF/plexus/components.xmlmerge-descriptors
doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/ 0000755 0001750 0001750 00000000000 11632765560 023427 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/test/ 0000755 0001750 0001750 00000000000 11632765560 024406 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765560 026420 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/test/resources/book.xml 0000644 0001750 0001750 00000013140 10663062216 030062 0 ustar twerner twerner
IntroductionThis document aims to help new geotools developers get up to speed
and track practices of existing developers in order to keep the project
consistent.If you feel something is missing, feel free to contribute a new
section.DesignGeotools LogoGeotools LogoTo do: ExplainKey design structure
(core interfaces, data sources, rendering, tools)Design
Drivers (Our design goals: modular, derives structure from netbeans,
support multiple version of java, ..)Directory
structureDevelopmentBuildingTo do:using antwhat
ant checksinsert the
"howto-build.html" doc into hereCode Versioning (using CVS)To do:Point to sourceforge CVS howto
links.Also point to some HOWTOs for
windows users.What is acceptable to
commit to CVS, what is not. (Ie, code should compile)Talk
about version numbering convention, use of branches, etc (if we decide
to do this).To do:Coding StandardsTo do:Using Sun's coding
standard, need to note any exceptions to it.Note
the auto checking of coding standards.JavadocsTemplate FileTo do:Provide a template file.Link
it to sections explaining the different parts of the template.Include
headers, footers, example logging, example coding style, CVS key tags,
sample javadocs.LoggingTo do:Talk about log4j, links toTestingTo do:Explain use of junit. Might be
a link to another web site.DocumentationTo do:Talk about docbook, why we
decided to use it (most commonly used format of LDP, converts to
multiple formats, tools coming which can support it. Need to mention
which version of docbook we are using.Mention
tools that can be used.Links to
docbook references.Process for
updating this document.How to use ant
tools to build doc.Development ToolsNetbeansTo do:Where to get it.Aim
is to make geotools a module within NetbeansHow
to setup getools to fit the multiple directory structureThe
extra Netbeans modules that are useful and should be downloaded.
doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/test/resources/test.xml 0000644 0001750 0001750 00000014114 11211670364 030110 0 ustar twerner twerner
]>
Geotools2 Developer Guide&flo;CameronShorter22 May 2002Guide to aid geotools2 development.IntroductionThis document aims to help new geotools developers get up to speed
and track practices of existing developers in order to keep the project
consistent.If you feel something is missing, feel free to contribute a new
section.DesignGeotools LogoGeotools LogoTo do: ExplainKey design structure
(core interfaces, data sources, rendering, tools)Design
Drivers (Our design goals: modular, derives structure from netbeans,
support multiple version of java, ..)Directory
structureDevelopmentBuildingTo do:using antwhat
ant checksinsert the
"howto-build.html" doc into hereCode Versioning (using CVS)To do:Point to sourceforge CVS howto
links.Also point to some HOWTOs for
windows users.What is acceptable to
commit to CVS, what is not. (Ie, code should compile)Talk
about version numbering convention, use of branches, etc (if we decide
to do this).To do:Coding StandardsTo do:Using Sun's coding
standard, need to note any exceptions to it.Note
the auto checking of coding standards.JavadocsTemplate FileTo do:Provide a template file.Link
it to sections explaining the different parts of the template.Include
headers, footers, example logging, example coding style, CVS key tags,
sample javadocs.LoggingTo do:Talk about log4j, links toTestingTo do:Explain use of junit. Might be
a link to another web site.DocumentationTo do:Talk about docbook, why we
decided to use it (most commonly used format of LDP, converts to
multiple formats, tools coming which can support it. Need to mention
which version of docbook we are using.Mention
tools that can be used.Links to
docbook references.Process for
updating this document.How to use ant
tools to build doc.Development ToolsNetbeansTo do:Where to get it.Aim
is to make geotools a module within NetbeansHow
to setup getools to fit the multiple directory structureThe
extra Netbeans modules that are useful and should be downloaded.
doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/test/resources/sdocbook_full.xml 0000644 0001750 0001750 00000042162 11215467777 032002 0 ustar twerner twerner
TitleOr How I Learned to LivecitetitleConfiguring MenusCorpAuthorDateAssn.articleinfo Abstract Titlearticleinfo Abstract ContentPhDMainAuthorSr.DDirector of Cooperative EffortsCooperative EngineeringTitlesuper hero.DrPeterDoeSr.SpidermanDirector of Cooperative EffortsCooperative EngineeringTitlesuper hero.Authorgroup CorpAuthorDrAuthorgroupAuthorSr.DDirector of Cooperative EffortsCooperative Engineeringauthorblurb titleHe's a super hero in his spare time.DrAuthorgroupEditorSr.SpidermanDirector of Cooperative EffortsCooperative Engineeringauthorblurb titleHe's a super hero in his spare time.DrAuthorgroupOtherCreditSr.AlterEgoDirector of Cooperative EffortsCooperative Engineeringauthorblurb titleHe's a super hero in his spare time.19961997meEditionDrPeterParkerSr.SpidermanDirector of Cooperative EffortsCooperative EngineeringTitlePeter's a super hero in his spare time.key1key2The Eiffel TowerDrJohnDoeSr.SpidermanDirector of Cooperative EffortsCooperative EngineeringTitlePeter's a super hero in his spare time.1994The TeX User's Groupbeta153No notice is required.0.9111 Dec 1996ndwBug fixes0.9030 Nov 1996ndwlong write upElectronic PublishingSGML (Computer program language)Abstract TitleIn brief.A trivial example of recursive sections.Section titleSub-section titleSub-sub-section titleSub-sub-sub-section titleSub-sub-sub-sub-section titleWilliam ShakespeareEpigraph: What say you?
The Assn. of Computing Machinery
has published Developing SGML DTDs.
In UNIX command ls
with the option is used to get a directory listing.
The output from the date command is eg
Sun Nov 16, 1997 21:03:29.
An email address is eg yo@tu.com.
The symbolic constants for error numbers are defined in
errno.h in
/usr/include/sys.
This software is provided as is.
Execute the command with
commandfilename.
This is hosted at helio.com.
The name pipipo is traded.
The name pipipo is registered.
The name pipipo is copyrighted.
The name pipipo is serviced.
The name pipipo is traded.
At the system prompt, enter xyzzy.
A SidebarSidebar content.
A link to an element with an XRefLabel: .
A straight link generates the cross-reference text: .
Phaser sound effectA sound effect.Italic font.
Bold font.
Monospaced font.
A Real Function
real function()Error!
William ShakespeareBlockquote: What say you?
An annual percentage rate of
3.27%The prime rate.
will be charged on all balances.
List item 1.List item 2.Paragraph contained in list item 2.Sub-list item 1.Sub-list item 2.List item 3. Force end of list:Verbatim text not contained in list item 3Numbered item 1.Numbered item A.Numbered item B.Numbered item 2.List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]].Defined term 1of definition list.Defined term 2of definition list.Verbatim text
in a box Figure title
The input has to be one of "all", "bottom",
* "none", "sides", "top" or "topbot",
* otherwise an IllegalArgumentException is thrown.
*
*
The corresponding output values are "box", "below",
* "void", "vsides", "above" and "hsides".
*
* @param frame a valid docbook table frame attribute as specified above,
* otherwise an IllegalArgumentException is thrown.
* @return a valid Doxia table frame attribute as specified above.
*/
public static String doxiaTableFrameAttribute( final String frame )
{
String fr = frame;
if ( "all".equals( fr ) )
{
fr = "box";
}
else if ( "bottom".equals( fr ) )
{
fr = "below";
}
else if ( "none".equals( fr ) )
{
fr = "void";
}
else if ( "sides".equals( fr ) )
{
fr = "vsides";
}
else if ( "top".equals( fr ) )
{
fr = "above";
}
else if ( "topbot".equals( fr ) )
{
fr = "hsides";
}
else
{
throw new IllegalArgumentException( "Not a valid frame attribute: " + fr );
}
return fr;
}
/**
* Convert a docbook ordered-list numbering style to a doxia numbering style.
*
*
The input has to be one of the style constants defined in {@link SimplifiedDocbookMarkup},
* otherwise an IllegalArgumentException is thrown.
*
*
The output is one of the numbering constants defined in {@link Sink}.
* @param style a docbook ordered-list numbering style.
* @return a doxia numbering style.
*/
public static int doxiaListNumbering( final String style )
{
if ( SimplifiedDocbookMarkup.LOWERALPHA_STYLE.equals( style ) )
{
return Sink.NUMBERING_LOWER_ALPHA;
}
else if ( SimplifiedDocbookMarkup.LOWERROMAN_STYLE.equals( style ) )
{
return Sink.NUMBERING_LOWER_ROMAN;
}
else if ( SimplifiedDocbookMarkup.UPPERALPHA_STYLE.equals( style ) )
{
return Sink.NUMBERING_UPPER_ALPHA;
}
else if ( SimplifiedDocbookMarkup.UPPERROMAN_STYLE.equals( style ) )
{
return Sink.NUMBERING_UPPER_ROMAN;
}
else if ( SimplifiedDocbookMarkup.ARABIC_STYLE.equals( style ) )
{
return Sink.NUMBERING_DECIMAL;
}
else
{
throw new IllegalArgumentException( "Not a valid numbering style: " + style );
}
}
/**
* Convert a doxia numbering style to a docbook ordered-list numbering style.
*
*
The input has to be one of the numbering constants defined in {@link Sink},
* otherwise an IllegalArgumentException is thrown.
*
*
The output is one of the style constants defined in {@link SimplifiedDocbookMarkup}.
* @param numbering a doxia numbering style.
* @return a docbook ordered-list numbering style.
*/
public static String docbookListNumbering( final int numbering )
{
switch ( numbering )
{
case Sink.NUMBERING_UPPER_ALPHA:
return SimplifiedDocbookMarkup.UPPERALPHA_STYLE;
case Sink.NUMBERING_LOWER_ALPHA:
return SimplifiedDocbookMarkup.LOWERALPHA_STYLE;
case Sink.NUMBERING_UPPER_ROMAN:
return SimplifiedDocbookMarkup.UPPERROMAN_STYLE;
case Sink.NUMBERING_LOWER_ROMAN:
return SimplifiedDocbookMarkup.LOWERROMAN_STYLE;
case Sink.NUMBERING_DECIMAL:
return SimplifiedDocbookMarkup.ARABIC_STYLE;
default:
throw new IllegalArgumentException( "Not a valid numbering: " + numbering );
}
}
/**
* Get a trademark character from a class attribute.
*
*
The input String has to be one of "registered", "copyright",
* "service" or "trade" otherwise an IllegalArgumentException is thrown.
*
*
The corresponding output is '\u00AE', '\u00A9',
* '\u2120' or '\u2122'.
*
* @param trade a valid class atribute for the docbook <trademark> tag.
* @return the corresponding unicode character.
*/
public static char trademarkFromClass( final String trade )
{
if ( "registered".equals( trade ) )
{
return '\u00AE';
}
else if ( "copyright".equals( trade ) )
{
return '\u00A9';
}
else if ( "service".equals( trade ) )
{
return '\u2120';
}
else if ( "trade".equals( trade ) )
{
return '\u2122';
}
else
{
throw new IllegalArgumentException( "Not a trademark class: " + trade );
}
}
private DocbookUtils()
{
// utility class
}
}
././@LongLink 0000000 0000000 0000000 00000000175 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocbookMarkup.java doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/do0000644 0001750 0001750 00000027677 11206503471 033337 0 ustar twerner twerner package org.apache.maven.doxia.module.docbook;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.markup.XmlMarkup;
/**
* List of DocBook markups.
* TODO: only use Simplified DocBook elements,
* remove full DocBook-only ones.
*
* @author Vincent Siveton
* @version $Id: DocbookMarkup.java 778398 2009-05-25 11:55:37Z ltheussl $
* @since 1.0
* @deprecated This interface is incomplete and will be removed. Use {@link SimplifiedDocbookMarkup} instead.
*/
public interface DocbookMarkup
extends XmlMarkup
{
/** DocBook V4.4 SGML public id: "-//OASIS//DTD DocBook V4.4//EN" */
String DEFAULT_SGML_PUBLIC_ID = "-//OASIS//DTD DocBook V4.4//EN";
/** DocBook XML V4.4 XML public id: "-//OASIS//DTD DocBook XML V4.4//EN" */
String DEFAULT_XML_PUBLIC_ID = "-//OASIS//DTD DocBook V4.4//EN";
/** DocBook XML V4.4 XML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" */
String DEFAULT_XML_SYSTEM_ID = "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd";
/** DocBook XML V4.4 SGML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" */
String DEFAULT_SGML_SYSTEM_ID = "http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd";
// ----------------------------------------------------------------------
// Specific DocBook tags
// ----------------------------------------------------------------------
/** DocBook tag for anchor */
Tag ANCHOR_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "anchor";
}
};
/** DocBook tag for article */
Tag ARTICLE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "article";
}
};
/** DocBook tag for articleinfo */
Tag ARTICLEINFO_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "articleinfo";
}
};
/** DocBook tag for book */
Tag BOOK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "book";
}
};
/** DocBook tag for bookinfo */
Tag BOOKINFO_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "bookinfo";
}
};
/** DocBook tag for chapter */
Tag CHAPTER_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "chapter";
}
};
/** DocBook tag for colspec */
Tag COLSPEC_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "colspec";
}
};
/** DocBook tag for corpauthor */
Tag CORPAUTHOR_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "corpauthor";
}
};
/** DocBook tag for date */
Tag DATE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "date";
}
};
/** DocBook tag for email */
Tag EMAIL_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "email";
}
};
/** DocBook tag for entry */
Tag ENTRY_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "entry";
}
};
/** DocBook tag for figure */
Tag FIGURE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "figure";
}
};
/** DocBook tag for formalpara */
Tag FORMALPARA_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "formalpara";
}
};
/** DocBook tag for imagedata */
Tag IMAGEDATA_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "imagedata";
}
};
/** DocBook tag for imageobject */
Tag IMAGEOBJECT_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "imageobject";
}
};
/** DocBook tag for info */
Tag INFO_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "info";
}
};
/** DocBook tag for informalfigure */
Tag INFORMALFIGURE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "informalfigure";
}
};
/** DocBook tag for informaltable */
Tag INFORMALTABLE_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "informaltable";
}
};
/** DocBook tag for itemizedlist */
Tag ITEMIZEDLIST_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "itemizedlist";
}
};
/** DocBook tag for link */
Tag LINK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "link";
}
};
/** DocBook tag for listitem */
Tag LISTITEM_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "listitem";
}
};
/** DocBook tag for mediaobject */
Tag MEDIAOBJECT_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "mediaobject";
}
};
/** DocBook tag for orderedlist */
Tag ORDEREDLIST_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "orderedlist";
}
};
/** DocBook tag for para */
Tag PARA_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "para";
}
};
/** DocBook tag for programlisting */
Tag PROGRAMLISTING_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "programlisting";
}
};
/** DocBook tag for row */
Tag ROW_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "row";
}
};
/** DocBook tag for section */
Tag SECTION_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "section";
}
};
/** DocBook tag for simpara */
Tag SIMPARA_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "simpara";
}
};
/** DocBook tag for tbody */
Tag TBODY_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "tbody";
}
};
/** DocBook tag for term */
Tag TERM_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "term";
}
};
/** DocBook tag for tgroup */
Tag TGROUP_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "tgroup";
}
};
/** DocBook tag for thead */
Tag THEAD_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "thead";
}
};
/** DocBook tag for ulink */
Tag ULINK_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "ulink";
}
};
/** DocBook tag for url */
Tag URL_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "url";
}
};
/** DocBook tag for variablelist */
Tag VARIABLELIST_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "variablelist";
}
};
/** DocBook tag for varlistentry */
Tag VARLISTENTRY_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "varlistentry";
}
};
/** DocBook tag for xref */
Tag XREF_TAG = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "xref";
}
};
// ----------------------------------------------------------------------
// Specific Docbook attributes
// ----------------------------------------------------------------------
/** DocBook attribute cols used in tgroup tags */
String COLS_ATTRIBUTE = "cols";
/** DocBook attribute colsep used in informaltable tags */
String COLSEP_ATTRIBUTE = "colsep";
/** DocBook attribute fileref used in orderedlist, imageobject tags */
String FILEREF_ATTRIBUTE = "fileref";
/** DocBook attribute format used in imagedata tags */
String FORMAT_ATTRIBUTE = "format";
/** DocBook attribute frame used in informaltable tags */
String FRAME_ATTRIBUTE = "frame";
/** DocBook attribute linkend used in link tag */
String LINKEND_ATTRIBUTE = "linkend";
/** DocBook attribute numeration used in orderedlist tag */
String NUMERATION_ATTRIBUTE = "numeration";
/** DocBook attribute rowsep used in informaltable tags */
String ROWSEP_ATTRIBUTE = "rowsep";
/** DocBook attribute url used in ulink tags */
String URL_ATTRIBUTE = "url";
// ----------------------------------------------------------------------
// Specific Docbook styles
// ----------------------------------------------------------------------
/** Docbook style arabic used in numeration attribute */
String ARABIC_STYLE = "arabic";
/** DocBook style loweralpha used in numeration attribute */
String LOWERALPHA_STYLE = "loweralpha";
/** DocBook style lowerroman used in numeration attribute */
String LOWERROMAN_STYLE = "lowerroman";
/** DocBook style upperalpha used in numeration attribute */
String UPPERALPHA_STYLE = "upperalpha";
/** DocBook style upperroman used in numeration attribute */
String UPPERROMAN_STYLE = "upperroman";
}
././@LongLink 0000000 0000000 0000000 00000000175 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookParser.java doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/do0000644 0001750 0001750 00000112333 11244500736 033322 0 ustar twerner twerner package org.apache.maven.doxia.module.docbook;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.util.Collection;
import java.util.HashSet;
import java.util.Stack;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.markup.HtmlMarkup;
import org.apache.maven.doxia.parser.AbstractXmlParser;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Parse a Simplified DocBook document
* and emit events into the specified doxia Sink.
*
* @author Jason van Zyl
* @version $Id: DocBookParser.java 807168 2009-08-24 12:04:46Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="docbook"
*/
public class DocBookParser
extends AbstractXmlParser
implements DocbookMarkup, SimplifiedDocbookMarkup
{
/**
* Level counter for calculating the section level.
*/
private int level;
/**
* Used to distinguish italic from bold.
*/
private boolean isBold;
private boolean inHead;
private boolean ignore;
private boolean simpleTag;
private char trademark;
/**
* A selective stack of parent elements
*/
private final Stack parent = new Stack();
/**
* The list of DocBook elements that introduce a new level of hierarchy.
*/
private static final Collection HIER_ELEMENTS = new HashSet();
/**
* Simplified DocBook elements that are direct children of <article>
* and that should be emitted into the Sink's head.
*/
private static final Collection META_ELEMENTS = new HashSet();
/**
* Simplified DocBook elements that occur within <articleinfo>
* and that are currently recognized by the parser.
*/
private static final Collection ARTICLEINFO_ELEMENTS = new HashSet();
/**
* The list of DocBook elements that will be rendered verbatim
*/
private static final Collection VERBATIM_ELEMENTS = new HashSet();
/**
* The list of DocBook elements that will be rendered inline and bold
*/
private static final Collection BOLD_ELEMENTS = new HashSet();
/**
* The list of DocBook elements that will be rendered inline and italic
*/
private static final Collection ITALIC_ELEMENTS = new HashSet();
/**
* The list of DocBook elements that will be rendered inline and monospace
*/
private static final Collection MONOSPACE_ELEMENTS = new HashSet();
/**
* The list of DocBook elements that may be ignored, either because they don't
* require any special processing or because they are not yet implemented.
*/
private static final Collection IGNORABLE_ELEMENTS = new HashSet();
static
{
META_ELEMENTS.add( SimplifiedDocbookMarkup.ARTICLEINFO_TAG.toString() );
META_ELEMENTS.add( SimplifiedDocbookMarkup.AUTHORBLURB_TAG.toString() );
META_ELEMENTS.add( SimplifiedDocbookMarkup.SUBTITLE_TAG.toString() );
META_ELEMENTS.add( SimplifiedDocbookMarkup.TITLE_TAG.toString() );
META_ELEMENTS.add( SimplifiedDocbookMarkup.TITLEABBREV_TAG.toString() );
ARTICLEINFO_ELEMENTS.add( SimplifiedDocbookMarkup.TITLE_TAG.toString() );
ARTICLEINFO_ELEMENTS.add( SimplifiedDocbookMarkup.CORPAUTHOR_TAG.toString() );
ARTICLEINFO_ELEMENTS.add( SimplifiedDocbookMarkup.DATE_TAG.toString() );
HIER_ELEMENTS.add( SimplifiedDocbookMarkup.SECTION_TAG.toString() );
HIER_ELEMENTS.add( SimplifiedDocbookMarkup.APPENDIX_TAG.toString() );
HIER_ELEMENTS.add( SimplifiedDocbookMarkup.BIBLIOGRAPHY_TAG.toString() );
HIER_ELEMENTS.add( SimplifiedDocbookMarkup.BIBLIODIV_TAG.toString() );
VERBATIM_ELEMENTS.add( SimplifiedDocbookMarkup.PROGRAMLISTING_TAG.toString() );
VERBATIM_ELEMENTS.add( SimplifiedDocbookMarkup.LITERALLAYOUT_TAG.toString() );
BOLD_ELEMENTS.add( SimplifiedDocbookMarkup.COMMAND_TAG.toString() );
BOLD_ELEMENTS.add( SimplifiedDocbookMarkup.USERINPUT_TAG.toString() );
ITALIC_ELEMENTS.add( SimplifiedDocbookMarkup.REPLACEABLE_TAG.toString() );
ITALIC_ELEMENTS.add( SimplifiedDocbookMarkup.SYSTEMITEM_TAG.toString() );
ITALIC_ELEMENTS.add( SimplifiedDocbookMarkup.CITETITLE_TAG.toString() );
ITALIC_ELEMENTS.add( SimplifiedDocbookMarkup.EMPHASIS_TAG.toString() );
ITALIC_ELEMENTS.add( SimplifiedDocbookMarkup.ATTRIBUTION_TAG.toString() );
ITALIC_ELEMENTS.add( SimplifiedDocbookMarkup.LINEANNOTATION_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.COMPUTEROUTPUT_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.REPLACEABLE_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.LITERAL_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.OPTION_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.SYSTEMITEM_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.USERINPUT_TAG.toString() );
MONOSPACE_ELEMENTS.add( SimplifiedDocbookMarkup.FILENAME_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.ABBREV_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.ABSTRACT_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.BIBLIOMIXED_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.BIBLIOMSET_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.COLSPEC_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.EPIGRAPH_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.EXAMPLE_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.FOOTNOTEREF_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.INLINEMEDIAOBJECT_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.ISSUENUM_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.PHRASE_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.PUBDATE_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.PUBLISHERNAME_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.SPANSPEC_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.TEXTOBJECT_TAG.toString() );
IGNORABLE_ELEMENTS.add( SimplifiedDocbookMarkup.VOLUMENUM_TAG.toString() );
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.parent.clear();
this.trademark = 0;
this.level = 0;
this.isBold = false;
this.inHead = false;
this.ignore = false;
this.simpleTag = false;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/** {@inheritDoc} */
protected void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( inHead && !META_ELEMENTS.contains( parser.getName() )
&& isParent( SimplifiedDocbookMarkup.ARTICLE_TAG.toString() ) )
{
sink.head_();
inHead = false;
// assume any element that is not meta starts the body
sink.body();
}
final SinkEventAttributeSet attribs = getAttributesFromParser( parser );
simpleTag = parser.isEmptyElementTag();
if ( parser.getName().equals( SimplifiedDocbookMarkup.ARTICLE_TAG.toString() ) )
{
handleArticleStart( sink, attribs );
}
else if ( isParent( SimplifiedDocbookMarkup.ARTICLEINFO_TAG.toString() ) )
{
handleArticleInfoStartTags( parser.getName(), sink, attribs );
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ARTICLEINFO_TAG.toString() ) )
{
parent.push( SimplifiedDocbookMarkup.ARTICLEINFO_TAG.toString() );
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.FOOTNOTE_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.SECTIONINFO_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.VIDEOOBJECT_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.AUDIOOBJECT_TAG.toString() ) )
{
parent.push( parser.getName() );
ignore = true;
}
else if ( isParent( ( SimplifiedDocbookMarkup.FOOTNOTE_TAG.toString() ) )
|| isParent( SimplifiedDocbookMarkup.AUDIOOBJECT_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.VIDEOOBJECT_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.SECTIONINFO_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.ENTRYTBL_TAG.toString() ) )
{
return; // TODO: implement footnotes, entrytbl
}
else if ( HIER_ELEMENTS.contains( parser.getName() ) )
{
handleSectionElements( sink, parser.getName(), attribs );
}
else if ( listStartTags ( parser.getName(), sink, attribs ) )
{
return;
}
else if ( mediaStartTag( parser.getName(), sink, attribs ) )
{
return;
}
else if ( tableStartTags( parser.getName(), sink, attribs ) )
{
return;
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.PARA_TAG.toString() ) )
{
handleParaStart( sink, attribs );
}
else if ( styleStartTags( parser.getName(), sink, attribs ) )
{
return;
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TITLE_TAG.toString() ) )
{
handleTitleStart( sink, attribs );
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.EMAIL_TAG.toString() ) )
{
handleEmailStart( parser, sink, attribs );
}
else if ( linkStartTag( parser.getName(), sink, attribs ) )
{
return;
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.QUOTE_TAG.toString() ) )
{
sink.text( "\"", null );
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TRADEMARK_TAG.toString() ) )
{
trademark = '\u2122';
final Object trade = attribs.getAttribute( "class" );
if ( trade != null )
{
trademark = DocbookUtils.trademarkFromClass( trade.toString() );
}
}
else
{
if ( !ignorable( parser.getName() ) )
{
if ( simpleTag )
{
handleUnknown( parser, sink, HtmlMarkup.TAG_TYPE_SIMPLE );
}
else
{
handleUnknown( parser, sink, HtmlMarkup.TAG_TYPE_START );
}
}
}
}
/** {@inheritDoc} */
protected void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( parser.getName().equals( SimplifiedDocbookMarkup.ARTICLE_TAG.toString() ) )
{
sink.body_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ARTICLEINFO_TAG.toString() ) )
{
parent.pop();
}
else if ( isParent( SimplifiedDocbookMarkup.ARTICLEINFO_TAG.toString() ) )
{
handleArticleInfoEndTags( parser.getName(), sink );
}
else if ( HIER_ELEMENTS.contains( parser.getName() ) )
{
sink.section_( level );
//decrease the nesting level
level--;
parent.pop();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.FOOTNOTE_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.AUDIOOBJECT_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.VIDEOOBJECT_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.SECTIONINFO_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.ENTRYTBL_TAG.toString() ) )
{
parent.pop();
ignore = false;
}
else if ( isParent( ( SimplifiedDocbookMarkup.FOOTNOTE_TAG.toString() ) )
|| isParent( SimplifiedDocbookMarkup.AUDIOOBJECT_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.VIDEOOBJECT_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.SECTIONINFO_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.ENTRYTBL_TAG.toString() ) )
{
return;
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG.toString() ) )
{
sink.list_();
parent.pop();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ORDEREDLIST_TAG.toString() ) )
{
sink.numberedList_();
parent.pop();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.LISTITEM_TAG.toString() ) )
{
parent.pop();
if ( isParent( SimplifiedDocbookMarkup.VARIABLELIST_TAG.toString() ) )
{
sink.definition_();
}
else if ( isParent( SimplifiedDocbookMarkup.ORDEREDLIST_TAG.toString() ) )
{
sink.numberedListItem_();
}
else
{
sink.listItem_();
}
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.VARIABLELIST_TAG.toString() ) )
{
sink.definitionList_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.VARLISTENTRY_TAG.toString() ) )
{
sink.definitionListItem_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TERM_TAG.toString() ) )
{
sink.definedTerm_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG.toString() ) )
{
sink.figure_();
parent.pop();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.FIGURE_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.THEAD_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.TFOOT_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.TBODY_TAG.toString() ) )
{
parent.pop();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.CAPTION_TAG.toString() ) )
{
handleCaptionEnd(sink);
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TABLE_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.INFORMALTABLE_TAG.toString() ) )
{
sink.table_();
parent.pop();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TR_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.ROW_TAG.toString() ) )
{
sink.tableRow_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TGROUP_TAG.toString() ) )
{
sink.tableRows_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ENTRY_TAG.toString() )
&& isParent( SimplifiedDocbookMarkup.THEAD_TAG.toString() )
|| parser.getName().equals( TH_TAG.toString() ) )
{
sink.tableHeaderCell_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ENTRY_TAG.toString() ) )
{
sink.tableCell_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.PARA_TAG.toString() ) )
{
handleParaEnd( sink );
}
else if ( VERBATIM_ELEMENTS.contains( parser.getName() ) )
{
sink.verbatim_();
}
else if ( BOLD_ELEMENTS.contains( parser.getName() )
&& MONOSPACE_ELEMENTS.contains( parser.getName() ) )
{
sink.monospaced_();
sink.bold_();
}
else if ( ITALIC_ELEMENTS.contains( parser.getName() )
&& MONOSPACE_ELEMENTS.contains( parser.getName() ) )
{
sink.monospaced_();
sink.italic_();
}
else if ( BOLD_ELEMENTS.contains( parser.getName() ) )
{
sink.bold_();
}
else if ( ITALIC_ELEMENTS.contains( parser.getName() ) )
{
if ( isBold )
{
sink.bold_();
isBold = false;
}
else
{
sink.italic_();
}
}
else if ( MONOSPACE_ELEMENTS.contains( parser.getName() ) )
{
sink.monospaced_();
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TITLE_TAG.toString() ) )
{
handleTitleEnd( sink );
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.ULINK_TAG.toString() )
|| parser.getName().equals( SimplifiedDocbookMarkup.LINK_TAG.toString() ) )
{
if ( isParent( parser.getName() ) )
{
parent.pop();
sink.link_();
}
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.QUOTE_TAG.toString() ) )
{
sink.text( "\"", null );
}
else if ( parser.getName().equals( SimplifiedDocbookMarkup.TRADEMARK_TAG.toString() ) )
{
sink.text( Character.toString( trademark ), null );
}
else if ( !simpleTag && !ignorable( parser.getName() ) )
{
handleUnknown( parser, sink, HtmlMarkup.TAG_TYPE_END );
}
}
/** {@inheritDoc} */
protected void handleComment( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
final String text = parser.getText();
if ( "PB".equals( text.trim() ) )
{
sink.pageBreak();
}
else if ( "HR".equals( text.trim() ) )
{
sink.horizontalRule();
}
else if ( "LB".equals( text.trim() ) )
{
sink.lineBreak();
}
else if ( "anchor_end".equals( text.trim() ) )
{
sink.anchor_();
}
else
{
sink.comment( text.trim() );
}
}
/** {@inheritDoc} */
protected void handleCdsect( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
if ( !ignore )
{
super.handleCdsect( parser, sink );
}
}
/** {@inheritDoc} */
protected void handleEntity( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
if ( !ignore )
{
super.handleEntity( parser, sink );
}
}
/** {@inheritDoc} */
protected void handleText( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
if ( !ignore )
{
super.handleText( parser, sink );
}
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
private void handleArticleInfoStartTags( String name, Sink sink, SinkEventAttributeSet attribs )
{
if ( !ARTICLEINFO_ELEMENTS.contains( name ) )
{
ignore = true;
return; // TODO: other meta data are ignored, implement!
}
if ( name.equals( SimplifiedDocbookMarkup.TITLE_TAG.toString() ) )
{
sink.title( attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.CORPAUTHOR_TAG.toString() ) )
{
sink.author( attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.DATE_TAG.toString() ) )
{
sink.date( attribs );
}
}
private void handleArticleInfoEndTags( String name, Sink sink )
{
if ( !ARTICLEINFO_ELEMENTS.contains( name ) )
{
ignore = false;
return; // TODO: other meta data are ignored, implement!
}
if ( name.equals( SimplifiedDocbookMarkup.TITLE_TAG.toString() ) )
{
sink.title_();
}
else if ( name.equals( SimplifiedDocbookMarkup.CORPAUTHOR_TAG.toString() ) )
{
sink.author_();
}
else if ( name.equals( SimplifiedDocbookMarkup.DATE_TAG.toString() ) )
{
sink.date_();
}
}
private void handleCaptionStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( isParent( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG.toString() ) )
{
sink.figureCaption( attribs );
}
else if ( isParent( SimplifiedDocbookMarkup.INFORMALTABLE_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.TABLE_TAG.toString() ) )
{
sink.tableCaption( attribs );
}
parent.push( SimplifiedDocbookMarkup.CAPTION_TAG.toString() );
}
private void handleCaptionEnd( Sink sink )
{
parent.pop();
if ( isParent( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG.toString() ) )
{
sink.figureCaption_();
}
else if ( isParent( SimplifiedDocbookMarkup.INFORMALTABLE_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.TABLE_TAG.toString() ) )
{
sink.tableCaption_();
}
}
private void handleEmailStart( XmlPullParser parser, Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
try
{
final String mailto = parser.nextText();
sink.link( "mailto:" + mailto, attribs );
sink.monospaced();
sink.text( mailto, null );
sink.monospaced_();
sink.link_();
}
catch ( IOException e )
{
throw new XmlPullParserException( "IOException: " + e.getMessage(), parser, e );
}
}
private void handleFigureStart( Sink sink, SinkEventAttributeSet attribs )
{
sink.figure( attribs );
parent.push( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG.toString() );
}
private void handleArticleStart( Sink sink, SinkEventAttributeSet attribs )
{
sink.head( attribs );
inHead = true;
parent.push( SimplifiedDocbookMarkup.ARTICLE_TAG.toString() );
}
//If the element introduces a new level of hierarchy, raise the stack
private void handleSectionElements( Sink sink, String name, SinkEventAttributeSet attribs )
{
//increase the nesting level
level++;
sink.section( level, attribs );
parent.push( name );
}
private void handleAnchorStart( Sink sink, SinkEventAttributeSet attribs )
{
final Object id = attribs.getAttribute( SimplifiedDocbookMarkup.ID_ATTRIBUTE );
if ( id != null )
{
sink.anchor( id.toString(), attribs );
}
}
private void handleImageDataStart( Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
final Object fileref = attribs.getAttribute( SimplifiedDocbookMarkup.FILEREF_ATTRIBUTE );
if ( fileref == null )
{
throw new XmlPullParserException( "Missing fileref attribute in imagedata!" );
}
sink.figureGraphics( fileref.toString(), attribs );
}
private void handleItemizedListStart( Sink sink, SinkEventAttributeSet attribs )
{
sink.list( attribs );
//for itemizedlists in variablelists
parent.push( SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG.toString() );
}
private void handleLinkStart( Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
final Object linkend = attribs.getAttribute( SimplifiedDocbookMarkup.LINKEND_ATTRIBUTE );
if ( linkend == null )
{
throw new XmlPullParserException( "Missing linkend attribute in link!" );
}
parent.push( SimplifiedDocbookMarkup.LINK_TAG.toString() );
sink.link( "#" + linkend.toString(), attribs );
}
private void handleListItemStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( isParent( SimplifiedDocbookMarkup.VARIABLELIST_TAG.toString() ) )
{
sink.definition( attribs );
}
else if ( isParent( SimplifiedDocbookMarkup.ORDEREDLIST_TAG.toString() ) )
{
sink.numberedListItem( attribs );
}
else
{
sink.listItem( attribs );
}
parent.push( SimplifiedDocbookMarkup.LISTITEM_TAG.toString() );
}
private void handleOrderedListStart( Sink sink, SinkEventAttributeSet attribs )
{
//default enumeration style is decimal
int numeration = Sink.NUMBERING_DECIMAL;
final Object num = attribs.getAttribute( SimplifiedDocbookMarkup.NUMERATION_ATTRIBUTE );
if ( num != null )
{
numeration = DocbookUtils.doxiaListNumbering( num.toString() );
}
sink.numberedList( numeration, attribs );
parent.push( SimplifiedDocbookMarkup.ORDEREDLIST_TAG.toString() );
}
private void handleParaEnd( Sink sink )
{
if ( !isParent( SimplifiedDocbookMarkup.CAPTION_TAG.toString() )
&& ! isParent( SimplifiedDocbookMarkup.LISTITEM_TAG.toString() ) )
{
sink.paragraph_();
}
}
private void handleParaStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( !isParent( SimplifiedDocbookMarkup.CAPTION_TAG.toString() )
&& ! isParent( SimplifiedDocbookMarkup.LISTITEM_TAG.toString() ) )
{
sink.paragraph( attribs );
}
}
private void handleTableStart( Sink sink, SinkEventAttributeSet attribs )
{
final Object frame = attribs.getAttribute( SimplifiedDocbookMarkup.FRAME_ATTRIBUTE );
if ( frame != null )
{
attribs.addAttribute( SimplifiedDocbookMarkup.FRAME_ATTRIBUTE,
DocbookUtils.doxiaTableFrameAttribute( frame.toString() ) );
}
sink.table( attribs );
parent.push( SimplifiedDocbookMarkup.TABLE_TAG.toString() );
}
private void handleTitleStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( isParent( SimplifiedDocbookMarkup.TABLE_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.INFORMALTABLE_TAG.toString() ) )
{
sink.tableCaption( attribs );
}
else if ( isParent( SimplifiedDocbookMarkup.ARTICLE_TAG.toString() ) )
{
sink.title( attribs );
}
else if ( isParent( SimplifiedDocbookMarkup.SECTION_TAG.toString() ) )
{
sink.sectionTitle( level, attribs );
}
else
{
sink.bold();
}
}
private void handleTitleEnd( Sink sink )
{
if ( isParent( SimplifiedDocbookMarkup.TABLE_TAG.toString() )
|| isParent( SimplifiedDocbookMarkup.INFORMALTABLE_TAG.toString() ) )
{
sink.tableCaption_();
}
else if ( isParent( SimplifiedDocbookMarkup.SECTION_TAG.toString() ) )
{
sink.sectionTitle_( level );
}
else if ( isParent( SimplifiedDocbookMarkup.ARTICLE_TAG.toString() ) )
{
sink.title_();
}
else
{
sink.bold_();
}
}
private void handleUlinkStart( Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
final Object url = attribs.getAttribute( SimplifiedDocbookMarkup.URL_ATTRIBUTE );
if ( url == null )
{
throw new XmlPullParserException( "Missing url attribute in ulink!" );
}
parent.push( SimplifiedDocbookMarkup.ULINK_TAG.toString() );
sink.link( url.toString(), attribs );
}
private void handleVariableListStart( Sink sink, SinkEventAttributeSet attribs )
{
sink.definitionList( attribs );
parent.push( SimplifiedDocbookMarkup.VARIABLELIST_TAG.toString() );
}
private void handleXrefStart( Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
final Object linkend = attribs.getAttribute( SimplifiedDocbookMarkup.LINKEND_ATTRIBUTE );
if ( linkend == null )
{
throw new XmlPullParserException( "Missing linkend attribute in xref!" );
}
sink.link( "#" + linkend.toString(), attribs );
sink.text( "Link" ); //TODO: determine text of link target
sink.link_();
}
private boolean ignorable( String name )
{
return IGNORABLE_ELEMENTS.contains( name );
}
/**
* Determines if the given element is a parent element.
*
* @param element the element to determine.
* @return true if the given element is a parent element.
*/
private boolean isParent( String element )
{
if ( parent.size() > 0 )
{
return parent.peek().equals( element );
}
return false;
}
private boolean linkStartTag( String name, Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
if ( name.equals( SimplifiedDocbookMarkup.ULINK_TAG.toString() ) )
{
handleUlinkStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.LINK_TAG.toString() ) )
{
handleLinkStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.XREF_TAG.toString() ) )
{
handleXrefStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.ANCHOR_TAG.toString() ) )
{
handleAnchorStart( sink, attribs );
}
else
{
return false;
}
return true;
}
private boolean listStartTags( String name, Sink sink, SinkEventAttributeSet attribs )
{
if ( name.equals( SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG.toString() ) )
{
handleItemizedListStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.ORDEREDLIST_TAG.toString() ) )
{
handleOrderedListStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.LISTITEM_TAG.toString() ) )
{
handleListItemStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.VARIABLELIST_TAG.toString() ) )
{
handleVariableListStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.VARLISTENTRY_TAG.toString() ) )
{
sink.definitionListItem( attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.TERM_TAG.toString() ) )
{
sink.definedTerm( attribs );
}
else
{
return false;
}
return true;
}
private boolean mediaStartTag( String name, Sink sink, SinkEventAttributeSet attribs )
throws XmlPullParserException
{
if ( name.equals( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG.toString() ) )
{
handleFigureStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG.toString() )
|| name.equals( SimplifiedDocbookMarkup.FIGURE_TAG.toString() ) )
{
parent.push( name );
}
else if ( name.equals( SimplifiedDocbookMarkup.IMAGEDATA_TAG.toString() ) )
{
handleImageDataStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.CAPTION_TAG.toString() ) )
{
handleCaptionStart( sink, attribs );
}
else
{
return false;
}
return true;
}
private boolean styleStartTags( String name, Sink sink, SinkEventAttributeSet attribs )
{
if ( VERBATIM_ELEMENTS.contains( name ) )
{
sink.verbatim( SinkEventAttributeSet.BOXED );
}
else if ( BOLD_ELEMENTS.contains( name ) && MONOSPACE_ELEMENTS.contains( name ) )
{
sink.bold();
sink.monospaced();
}
else if ( ITALIC_ELEMENTS.contains( name ) && MONOSPACE_ELEMENTS.contains( name ) )
{
sink.italic();
sink.monospaced();
}
else if ( BOLD_ELEMENTS.contains( name ) )
{
sink.bold();
}
else if ( ITALIC_ELEMENTS.contains( name ) && "bold".equals( attribs.getAttribute( "role" ) ) )
{
sink.bold();
isBold = true;
}
else if ( ITALIC_ELEMENTS.contains( name ) )
{
sink.italic();
}
else if ( MONOSPACE_ELEMENTS.contains( name ) )
{
sink.monospaced();
}
else
{
return false;
}
return true;
}
private boolean tableStartTags( String name, Sink sink, SinkEventAttributeSet attribs )
{
if ( name.equals( SimplifiedDocbookMarkup.ENTRYTBL_TAG.toString() ) )
{
parent.push( name );
ignore = true;
// insert empty table cell instead
sink.tableCell( (SinkEventAttributeSet) null );
sink.tableCell_();
}
else if ( name.equals( SimplifiedDocbookMarkup.TABLE_TAG.toString() )
|| name.equals( SimplifiedDocbookMarkup.INFORMALTABLE_TAG.toString() ) )
{
handleTableStart( sink, attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.THEAD_TAG.toString() )
|| name.equals( SimplifiedDocbookMarkup.TFOOT_TAG.toString() )
|| name.equals( SimplifiedDocbookMarkup.TBODY_TAG.toString() ) )
{
parent.push( name );
}
else if ( name.equals( SimplifiedDocbookMarkup.TGROUP_TAG.toString() ) )
{
// this is required by the DTD
final int cols = Integer.parseInt( (String) attribs.getAttribute( "cols" ) );
int[] justification = new int[cols];
int justif = Sink.JUSTIFY_LEFT;
final Object align = attribs.getAttribute( SinkEventAttributeSet.ALIGN );
if ( align != null )
{
final String al = align.toString();
if ( "right".equals( al ) )
{
justif = Sink.JUSTIFY_RIGHT;
}
else if ( "center".equals( al ) )
{
justif = Sink.JUSTIFY_CENTER;
}
}
for ( int i = 0; i < justification.length; i++ )
{
justification[i] = justif;
}
boolean grid = false;
final Object rowsep = attribs.getAttribute( "rowsep" );
if ( rowsep != null && Integer.parseInt( (String) rowsep ) == 1 )
{
grid = true;
}
final Object colsep = attribs.getAttribute( "colsep" );
if ( colsep != null && Integer.parseInt( (String) colsep ) == 1 )
{
grid = true;
}
sink.tableRows( justification, grid );
}
else if ( name.equals( SimplifiedDocbookMarkup.TR_TAG.toString() )
|| name.equals( SimplifiedDocbookMarkup.ROW_TAG.toString() ) )
{
sink.tableRow( attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.ENTRY_TAG.toString() )
&& isParent( SimplifiedDocbookMarkup.THEAD_TAG.toString() )
|| name.equals( SimplifiedDocbookMarkup.TH_TAG.toString() ) )
{
sink.tableHeaderCell( attribs );
}
else if ( name.equals( SimplifiedDocbookMarkup.ENTRY_TAG.toString() ) )
{
sink.tableCell( attribs );
}
else
{
return false;
}
return true;
}
}
././@LongLink 0000000 0000000 0000000 00000000173 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSink.java doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/do0000644 0001750 0001750 00000124064 11244500736 033326 0 ustar twerner twerner package org.apache.maven.doxia.module.docbook;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.StringTokenizer;
import java.util.TreeSet;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.SimpleAttributeSet;
import org.apache.maven.doxia.sink.AbstractXmlSink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.StringUtils;
/**
* Docbook Sink implementation.
*
* It uses the Docbook v4.4 DTD
* http://www.oasis-open.org/docbook/sgml/4.4/docbookx.dtd.
*
* @version $Id: DocBookSink.java 807168 2009-08-24 12:04:46Z vsiveton $
* @since 1.0
*/
public class DocBookSink
extends AbstractXmlSink
implements DocbookMarkup, SimplifiedDocbookMarkup
{
/** DocBook V4.4 SGML public id: "-//OASIS//DTD DocBook V4.4//EN"
* @deprecated since 1.1, use {@link DocbookMarkup#DEFAULT_SGML_PUBLIC_ID} instead of. */
public static final String DEFAULT_SGML_PUBLIC_ID = DocbookMarkup.DEFAULT_SGML_PUBLIC_ID;
/** DocBook XML V4.4 XML public id: "-//OASIS//DTD DocBook XML V4.4//EN"
* @deprecated since 1.1, use {@link DocbookMarkup#DEFAULT_XML_PUBLIC_ID} instead of. */
public static final String DEFAULT_XML_PUBLIC_ID = DocbookMarkup.DEFAULT_XML_PUBLIC_ID;
/** DocBook XML V4.4 XML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
* @deprecated since 1.1, use {@link DocbookMarkup#DEFAULT_XML_SYSTEM_ID} instead of. */
public static final String DEFAULT_XML_SYSTEM_ID = DocbookMarkup.DEFAULT_XML_SYSTEM_ID;
/** DocBook XML V4.4 SGML system id: "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
* @deprecated since 1.1, use {@link DocbookMarkup#DEFAULT_SGML_SYSTEM_ID} instead of. */
public static final String DEFAULT_SGML_SYSTEM_ID = DocbookMarkup.DEFAULT_SGML_SYSTEM_ID;
/** The output writer. */
private PrintWriter out;
/** xmlMode. */
private boolean xmlMode = false;
/** styleSheet. */
private String styleSheet = null;
/** language. */
private String lang = null;
/** publicId. */
private String publicId = null;
/** systemId. */
private String systemId = null;
/** italicBegin. */
private String italicBeginTag;
/** italicEnd. */
private String italicEndTag;
/** boldBegin. */
private String boldBeginTag;
/** boldEnd. */
private String boldEndTag;
/** monospacedBegin. */
private String monospacedBeginTag;
/** monospacedEnd. */
private String monospacedEndTag;
/** horizontalRule. */
private String horizontalRuleElement;
/** pageBreak. */
private String pageBreakElement;
/** lineBreak. */
private String lineBreakElement;
/** An image source file. */
private String graphicsFileName;
/** hasTitle. */
private boolean hasTitle;
/** authorDate. */
private boolean authorDateFlag;
/** verbatim. */
private boolean verbatimFlag;
/** externalLink. */
private boolean externalLinkFlag;
/** tableHasCaption. */
private boolean tableHasCaption;
/** Used for table rows. */
private PrintWriter savedOut;
/** tableRows. */
private String tableRows;
/** tableRows writer. */
private StringWriter tableRowsWriter;
/** tableHasGrid. */
private boolean tableHasGrid;
private boolean skip;
private boolean paragraph;
private String encoding;
/** Map of warn messages with a String as key to describe the error type and a Set as value.
* Using to reduce warn messages. */
private Map warnMessages;
/**
* Constructor, initialize the Writer.
*
* @param writer not null writer to write the result. Should be an UTF-8 Writer.
* You could use newXmlWriter methods from {@link org.codehaus.plexus.util.WriterFactory}.
*/
protected DocBookSink( Writer writer )
{
this( writer, null );
}
/**
* Constructor, initialize the Writer and tells which encoding is used.
*
* @param writer not null writer to write the result.
* @param encoding the encoding used, that should be written to the generated HTML content
* if not null.
*/
protected DocBookSink( Writer writer, String encoding )
{
this.out = new PrintWriter( writer );
this.encoding = encoding;
setItalicElement( "" );
setBoldElement( "" );
setMonospacedElement( "" );
setHorizontalRuleElement( "" );
setPageBreakElement( "" );
setLineBreakElement( "" );
}
/**
* Constructor, initialize the Writer and tells which encoding and languageId are used.
*
* @param writer not null writer to write the result.
* @param encoding the encoding used, that should be written to the generated HTML content
* if not null.
* @param languageId language identifier for the root element as defined by
* IETF BCP 47, Tags for the Identification of Languages;
* in addition, the empty string may be specified.
* @since 1.1
*/
protected DocBookSink( Writer writer, String encoding, String languageId )
{
this( writer, encoding );
this.lang = languageId;
}
/**
*
escapeSGML
*
* @param text The text to escape.
* @param xmlMode xmlMode.
* @return The escaped text.
* @deprecated Use HtmlTools#escapeHTML(String,boolean).
*/
public static final String escapeSGML( String text, boolean xmlMode )
{
return HtmlTools.escapeHTML( text, xmlMode );
}
/**
* Sets the xml mode.
*
* @param mode the mode to set.
* @deprecated xml mode is not used.
*/
public void setXMLMode( boolean mode )
{
this.xmlMode = mode;
}
/**
* Returns the current xmlMode.
*
* @return the current xmlMode.
* @deprecated xml mode is not used.
*/
public boolean isXMLMode()
{
return xmlMode;
}
/**
* Sets the encoding. The encoding specified here must be consistent with then encoding
* used in the Writer used by this DocBookSink instance.
*
* @param enc the encoding to set.
*/
public void setEncoding( String enc )
{
encoding = enc;
}
/**
* Returns the encoding.
*
* @return the encoding set (can be null).
*/
public String getEncoding()
{
return encoding;
}
/**
* Sets the styleSheet.
*
* @param sheet the styleSheet to set.
*/
public void setStyleSheet( String sheet )
{
this.styleSheet = sheet;
}
/**
* Returns the current styleSheet.
*
* @return the current styleSheet.
*/
public String getStyleSheet()
{
return styleSheet;
}
/**
* Sets the publicId.
*
* @param id the publicId to set.
*/
public void setPublicId( String id )
{
this.publicId = id;
}
/**
* Returns the current publicId.
*
* @return the current publicId.
*/
public String getPublicId()
{
return publicId;
}
/**
* Sets the systemId.
*
* @param id the systemId to set.
*/
public void setSystemId( String id )
{
this.systemId = id;
}
/**
* Returns the current systemId.
*
* @return the current systemId.
*/
public String getSystemId()
{
return systemId;
}
/**
* Sets the language.
*
* @param language the language to set.
*/
public void setLanguage( String language )
{
this.lang = language;
}
/**
* Returns the current language.
*
* @return the current language.
*/
public String getLanguage()
{
return lang;
}
/**
* Sets the current italicBeginTag and constructs the corresponding end tag from it.
*
* @param tag the tag to set. If tag is null, the empty string is used.
*/
public void setItalicElement( String tag )
{
if ( tag == null )
{
tag = "";
}
this.italicBeginTag = tag;
italicEndTag = makeEndTag( italicBeginTag );
}
/**
* Constructs the corresponding end tag from the given begin tag.
*
* @param beginTag the begin tag to set. If null, the empty string is returned.
* @return the corresponding end tag.
*/
private String makeEndTag( String beginTag )
{
int length = beginTag.length();
if ( length == 0 )
{
return "";
}
if ( beginTag.charAt( 0 ) != '<' || beginTag.charAt( length - 1 ) != '>' )
{
throw new IllegalArgumentException( "'" + beginTag + "', not a tag" );
}
StringTokenizer tokens = new StringTokenizer( beginTag, "<> \t\n\r\f" );
if ( !tokens.hasMoreTokens() )
{
throw new IllegalArgumentException( "'" + beginTag + "', invalid tag" );
}
return "";
}
/**
* Returns the current italicBeginTag.
*
* @return the current italicBeginTag. Defaults to "".
*/
public String getItalicElement()
{
return italicBeginTag;
}
/**
* Sets the current boldBeginTag and constructs the corresponding end tag from it.
*
* @param tag the tag to set. If tag is null, the empty string is used.
*/
public void setBoldElement( String tag )
{
if ( tag == null )
{
tag = "";
}
this.boldBeginTag = tag;
boldEndTag = makeEndTag( boldBeginTag );
}
/**
* Returns the current boldBeginTag.
*
* @return the current boldBeginTag. Defaults to "".
*/
public String getBoldElement()
{
return boldBeginTag;
}
/**
* Sets the current monospacedBeginTag and constructs the corresponding end tag from it.
*
* @param tag the tag to set. If tag is null, the empty string is used.
*/
public void setMonospacedElement( String tag )
{
if ( tag == null )
{
tag = "";
}
this.monospacedBeginTag = tag;
monospacedEndTag = makeEndTag( monospacedBeginTag );
}
/**
* Returns the current monospacedBeginTag.
*
* @return the current monospacedBeginTag. Defaults to ">".
*/
public String getMonospacedElement()
{
return monospacedBeginTag;
}
/**
* Sets the current horizontalRuleElement.
*
* @param element the element to set.
*/
public void setHorizontalRuleElement( String element )
{
this.horizontalRuleElement = element;
}
/**
* Returns the current horizontalRuleElement.
*
* @return the current horizontalRuleElement. Defaults to "".
*/
public String getHorizontalRuleElement()
{
return horizontalRuleElement;
}
/**
* Sets the current pageBreakElement.
*
* @param element the element to set.
*/
public void setPageBreakElement( String element )
{
this.pageBreakElement = element;
}
/**
* Returns the current pageBreakElement.
*
* @return the current pageBreakElement. Defaults to "".
*/
public String getPageBreakElement()
{
return pageBreakElement;
}
/**
* Sets the current lineBreakElement.
*
* @param element the element to set.
*/
public void setLineBreakElement( String element )
{
this.lineBreakElement = element;
}
/**
* Returns the current lineBreakElement.
*
* @return the current lineBreakElement. Defaults to "".
*/
public String getLineBreakElement()
{
return lineBreakElement;
}
/**
* Reset all variables.
*
* @deprecated since 1.1.2, use {@link #init()} instead of.
*/
protected void resetState()
{
init();
}
/** {@inheritDoc} */
protected void init()
{
hasTitle = false;
authorDateFlag = false;
verbatimFlag = false;
externalLinkFlag = false;
graphicsFileName = null;
tableHasCaption = false;
savedOut = null;
tableRows = null;
tableHasGrid = false;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#DEFAULT_XML_PUBLIC_ID
* @see SimplifiedDocbookMarkup#DEFAULT_XML_SYSTEM_ID
* @see SimplifiedDocbookMarkup#ARTICLE_TAG
*/
public void head()
{
init();
MutableAttributeSet att = writeXmlHeader( "article" );
writeStartTag( SimplifiedDocbookMarkup.ARTICLE_TAG, att );
}
/**
* writeXmlHeader.
*
* @param root not null.
* @return an attribute set.
* @see SimplifiedDocbookMarkup#DEFAULT_XML_PUBLIC_ID
* @see SimplifiedDocbookMarkup#DEFAULT_XML_SYSTEM_ID
* @see SimplifiedDocbookMarkup#ARTICLE_TAG
* @since 1.1
*/
protected MutableAttributeSet writeXmlHeader( String root )
{
markup( "" );
if ( styleSheet != null )
{
markup( "" );
}
String pubId;
markup( "" );
MutableAttributeSet att = new SimpleAttributeSet();
if ( lang != null )
{
att.addAttribute( LANG_ATTRIBUTE, lang );
}
return att;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ARTICLEINFO_TAG
*/
public void head_()
{
if ( hasTitle )
{
writeEndTag( SimplifiedDocbookMarkup.ARTICLEINFO_TAG );
hasTitle = false;
}
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ARTICLEINFO_TAG
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void title()
{
writeStartTag( SimplifiedDocbookMarkup.ARTICLEINFO_TAG );
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
hasTitle = true;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void title_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#CORPAUTHOR_TAG
*/
public void author()
{
authorDateFlag = true;
writeStartTag( SimplifiedDocbookMarkup.CORPAUTHOR_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#CORPAUTHOR_TAG
*/
public void author_()
{
writeEndTag( SimplifiedDocbookMarkup.CORPAUTHOR_TAG );
authorDateFlag = false;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#DATE_TAG
*/
public void date()
{
authorDateFlag = true;
writeStartTag( SimplifiedDocbookMarkup.DATE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#DATE_TAG
*/
public void date_()
{
writeEndTag( SimplifiedDocbookMarkup.DATE_TAG );
authorDateFlag = false;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ARTICLE_TAG
*/
public void body_()
{
writeEndTag( SimplifiedDocbookMarkup.ARTICLE_TAG );
out.flush();
init();
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section1()
{
writeStartTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section1_()
{
writeEndTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section2()
{
writeStartTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section2_()
{
writeEndTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section3()
{
writeStartTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section3_()
{
writeEndTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section4()
{
writeStartTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section4_()
{
writeEndTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section5()
{
writeStartTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#SECTION_TAG
*/
public void section5_()
{
writeEndTag( SimplifiedDocbookMarkup.SECTION_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle()
{
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle1()
{
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle1_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle2()
{
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle2_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle3()
{
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle3_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle4()
{
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle4_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle5()
{
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void sectionTitle5_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ITEMIZEDLIST_TAG
*/
public void list()
{
paragraph_();
writeStartTag( SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ITEMIZEDLIST_TAG
*/
public void list_()
{
writeEndTag( SimplifiedDocbookMarkup.ITEMIZEDLIST_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void listItem()
{
writeStartTag( SimplifiedDocbookMarkup.LISTITEM_TAG );
paragraph();
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void listItem_()
{
paragraph_();
writeEndTag( SimplifiedDocbookMarkup.LISTITEM_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ORDEREDLIST_TAG
* @see SimplifiedDocbookMarkup#NUMERATION_ATTRIBUTE
*/
public void numberedList( int numbering )
{
String numeration = DocbookUtils.docbookListNumbering( numbering );
paragraph_();
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.NUMERATION_ATTRIBUTE, numeration );
writeStartTag( SimplifiedDocbookMarkup.ORDEREDLIST_TAG, att );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ORDEREDLIST_TAG
*/
public void numberedList_()
{
writeEndTag( SimplifiedDocbookMarkup.ORDEREDLIST_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void numberedListItem()
{
writeStartTag( SimplifiedDocbookMarkup.LISTITEM_TAG );
paragraph();
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void numberedListItem_()
{
paragraph_();
writeEndTag( SimplifiedDocbookMarkup.LISTITEM_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#VARIABLELIST_TAG
*/
public void definitionList()
{
paragraph_();
writeStartTag( SimplifiedDocbookMarkup.VARIABLELIST_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#VARIABLELIST_TAG
*/
public void definitionList_()
{
writeEndTag( SimplifiedDocbookMarkup.VARIABLELIST_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#VARLISTENTRY_TAG
*/
public void definitionListItem()
{
writeStartTag( SimplifiedDocbookMarkup.VARLISTENTRY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#VARLISTENTRY_TAG
*/
public void definitionListItem_()
{
writeEndTag( SimplifiedDocbookMarkup.VARLISTENTRY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TERM_TAG
*/
public void definedTerm()
{
writeStartTag( SimplifiedDocbookMarkup.TERM_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TERM_TAG
*/
public void definedTerm_()
{
writeEndTag( SimplifiedDocbookMarkup.TERM_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void definition()
{
writeStartTag( SimplifiedDocbookMarkup.LISTITEM_TAG );
paragraph();
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#LISTITEM_TAG
*/
public void definition_()
{
paragraph_();
writeEndTag( SimplifiedDocbookMarkup.LISTITEM_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#PARA_TAG
*/
public void paragraph()
{
if ( !paragraph )
{
writeStartTag( SimplifiedDocbookMarkup.PARA_TAG );
paragraph = true;
}
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#PARA_TAG
*/
public void paragraph_()
{
if ( paragraph )
{
writeEndTag( SimplifiedDocbookMarkup.PARA_TAG );
paragraph = false;
}
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#PROGRAMLISTING_TAG
*/
public void verbatim( boolean boxed )
{
verbatimFlag = true;
paragraph_();
writeStartTag( SimplifiedDocbookMarkup.PROGRAMLISTING_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#PROGRAMLISTING_TAG
*/
public void verbatim_()
{
writeEndTag( SimplifiedDocbookMarkup.PROGRAMLISTING_TAG );
verbatimFlag = false;
}
/** {@inheritDoc} */
public void horizontalRule()
{
markup( horizontalRuleElement );
}
/** {@inheritDoc} */
public void pageBreak()
{
markup( pageBreakElement );
}
/** {@inheritDoc} */
public void figure()
{
writeStartTag( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG );
}
/** {@inheritDoc} */
public void figure_()
{
writeEndTag( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG );
}
/**
*
graphicElement
*
* @see SimplifiedDocbookMarkup#MEDIAOBJECT_TAG
* @see SimplifiedDocbookMarkup#IMAGEOBJECT_TAG
* @see SimplifiedDocbookMarkup#IMAGEDATA_TAG
* @see SimplifiedDocbookMarkup#FORMAT_ATTRIBUTE
* @see SimplifiedDocbookMarkup#FILEREF_ATTRIBUTE
* @deprecated do not use!
*/
protected void graphicElement()
{
if ( graphicsFileName != null )
{
String format = FileUtils.extension( graphicsFileName ).toUpperCase( Locale.ENGLISH );
if ( format.length() == 0 )
{
format = "JPEG";
}
writeStartTag( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG );
writeStartTag( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG );
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.FORMAT_ATTRIBUTE, format );
att.addAttribute( SimplifiedDocbookMarkup.FILEREF_ATTRIBUTE,
HtmlTools.escapeHTML( graphicsFileName, true ) );
writeSimpleTag( SimplifiedDocbookMarkup.IMAGEDATA_TAG, att );
writeEndTag( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG );
writeEndTag( SimplifiedDocbookMarkup.MEDIAOBJECT_TAG );
graphicsFileName = null;
}
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
String format = FileUtils.extension( name ).toUpperCase( Locale.ENGLISH );
writeStartTag( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG );
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.FORMAT_ATTRIBUTE, format );
att.addAttribute( SimplifiedDocbookMarkup.FILEREF_ATTRIBUTE, HtmlTools.escapeHTML( name, true ) );
writeSimpleTag( SimplifiedDocbookMarkup.IMAGEDATA_TAG, att );
writeEndTag( SimplifiedDocbookMarkup.IMAGEOBJECT_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#FIGURE_TAG
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void figureCaption()
{
writeStartTag( SimplifiedDocbookMarkup.CAPTION_TAG );
writeStartTag( SimplifiedDocbookMarkup.PARA_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#FIGURE_TAG
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void figureCaption_()
{
writeEndTag( SimplifiedDocbookMarkup.PARA_TAG );
writeEndTag( SimplifiedDocbookMarkup.CAPTION_TAG );
}
/** {@inheritDoc} */
public void table()
{
tableHasCaption = false;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#INFORMALTABLE_TAG
* @see SimplifiedDocbookMarkup#FRAME_ATTRIBUTE
* @see SimplifiedDocbookMarkup#ROWSEP_ATTRIBUTE
* @see SimplifiedDocbookMarkup#COLSEP_ATTRIBUTE
* @see SimplifiedDocbookMarkup#TABLE_TAG
*/
public void table_()
{
if ( tableHasCaption )
{
tableHasCaption = false;
// Formal table+title already written to original destination ---
out.write( tableRows );
writeEndTag( TABLE_TAG );
}
else
{
String frame = "none";
String sep = "0";
if ( tableHasGrid )
{
frame = "all";
sep = "1";
}
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.FRAME_ATTRIBUTE, frame );
att.addAttribute( SimplifiedDocbookMarkup.ROWSEP_ATTRIBUTE, sep );
att.addAttribute( SimplifiedDocbookMarkup.COLSEP_ATTRIBUTE, sep );
writeStartTag( SimplifiedDocbookMarkup.INFORMALTABLE_TAG, att );
out.write( tableRows );
writeEndTag( SimplifiedDocbookMarkup.INFORMALTABLE_TAG );
}
tableRows = null;
tableHasGrid = false;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TGROUP_TAG
* @see SimplifiedDocbookMarkup#COLS_ATTRIBUTE
* @see SimplifiedDocbookMarkup#COLSPEC_TAG
*/
public void tableRows( int[] justification, boolean grid )
{
tableHasGrid = grid;
// Divert output to a string ---
out.flush();
savedOut = out;
tableRowsWriter = new StringWriter();
out = new PrintWriter( tableRowsWriter );
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.COLS_ATTRIBUTE, String.valueOf( justification.length ) );
writeStartTag( SimplifiedDocbookMarkup.TGROUP_TAG, att );
for ( int i = 0; i < justification.length; ++i )
{
String justif;
switch ( justification[i] )
{
case Sink.JUSTIFY_LEFT:
justif = "left";
break;
case Sink.JUSTIFY_RIGHT:
justif = "right";
break;
case Sink.JUSTIFY_CENTER:
default:
justif = "center";
break;
}
att = new SimpleAttributeSet();
att.addAttribute( "align", justif );
writeSimpleTag( SimplifiedDocbookMarkup.COLSPEC_TAG, att );
}
writeStartTag( SimplifiedDocbookMarkup.TBODY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TGROUP_TAG
* @see SimplifiedDocbookMarkup#TBODY_TAG
*/
public void tableRows_()
{
writeEndTag( SimplifiedDocbookMarkup.TBODY_TAG );
writeEndTag( SimplifiedDocbookMarkup.TGROUP_TAG );
// Remember diverted output and restore original destination ---
out.flush();
if ( tableRowsWriter == null )
{
throw new IllegalArgumentException( "tableRows( int[] justification, boolean grid )"
+ " was not called before." );
}
tableRows = tableRowsWriter.toString();
tableRowsWriter = null;
out = savedOut;
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ROW_TAG
*/
public void tableRow()
{
writeStartTag( SimplifiedDocbookMarkup.ROW_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ROW_TAG
*/
public void tableRow_()
{
writeEndTag( SimplifiedDocbookMarkup.ROW_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableCell()
{
writeStartTag( SimplifiedDocbookMarkup.ENTRY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableCell_()
{
writeEndTag( SimplifiedDocbookMarkup.ENTRY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableHeaderCell()
{
writeStartTag( SimplifiedDocbookMarkup.ENTRY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ENTRY_TAG
*/
public void tableHeaderCell_()
{
writeEndTag( SimplifiedDocbookMarkup.ENTRY_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TABLE_TAG
* @see SimplifiedDocbookMarkup#FRAME_ATTRIBUTE
* @see SimplifiedDocbookMarkup#ROWSEP_ATTRIBUTE
* @see SimplifiedDocbookMarkup#COLSEP_ATTRIBUTE
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void tableCaption()
{
tableHasCaption = true;
String frame;
int sep;
if ( tableHasGrid )
{
frame = "all";
sep = 1;
}
else
{
frame = "none";
sep = 0;
}
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.FRAME_ATTRIBUTE, frame );
att.addAttribute( SimplifiedDocbookMarkup.ROWSEP_ATTRIBUTE, String.valueOf( sep ) );
att.addAttribute( SimplifiedDocbookMarkup.COLSEP_ATTRIBUTE, String.valueOf( sep ) );
writeStartTag( TABLE_TAG, att );
writeStartTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#TITLE_TAG
*/
public void tableCaption_()
{
writeEndTag( SimplifiedDocbookMarkup.TITLE_TAG );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ANCHOR_TAG
*/
public void anchor( String name )
{
if ( name == null )
{
throw new NullPointerException( "Anchor name cannot be null!" );
}
if ( authorDateFlag )
{
return;
}
String id = name;
if ( !DoxiaUtils.isValidId( id ) )
{
id = DoxiaUtils.encodeId( name, true );
String msg = "Modified invalid anchor name: '" + name + "' to '" + id + "'";
logMessage( "modifiedLink", msg );
}
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( ID_ATTRIBUTE, id );
writeSimpleTag( SimplifiedDocbookMarkup.ANCHOR_TAG, att );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ANCHOR_TAG
*/
public void anchor_()
{
comment( "anchor_end" );
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ULINK_TAG
* @see SimplifiedDocbookMarkup#URL_ATTRIBUTE
* @see SimplifiedDocbookMarkup#LINK_TAG
* @see SimplifiedDocbookMarkup#LINKEND_ATTRIBUTE
*/
public void link( String name )
{
if ( name == null )
{
throw new NullPointerException( "Link name cannot be null!" );
}
if ( DoxiaUtils.isInternalLink( name ) )
{
String linkend = name.substring( 1 );
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.LINKEND_ATTRIBUTE, HtmlTools.escapeHTML( linkend ) );
writeStartTag( SimplifiedDocbookMarkup.LINK_TAG, att );
}
else
{
externalLinkFlag = true;
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( SimplifiedDocbookMarkup.URL_ATTRIBUTE, HtmlTools.escapeHTML( name, true ) );
writeStartTag( SimplifiedDocbookMarkup.ULINK_TAG, att );
}
}
/**
* {@inheritDoc}
* @see SimplifiedDocbookMarkup#ULINK_TAG
* @see SimplifiedDocbookMarkup#LINK_TAG
*/
public void link_()
{
if ( externalLinkFlag )
{
writeEndTag( SimplifiedDocbookMarkup.ULINK_TAG );
externalLinkFlag = false;
}
else
{
writeEndTag( SimplifiedDocbookMarkup.LINK_TAG );
}
}
/** {@inheritDoc} */
public void italic()
{
markup( italicBeginTag );
}
/** {@inheritDoc} */
public void italic_()
{
markup( italicEndTag );
}
/** {@inheritDoc} */
public void bold()
{
markup( boldBeginTag );
}
/** {@inheritDoc} */
public void bold_()
{
markup( boldEndTag );
}
/** {@inheritDoc} */
public void monospaced()
{
if ( !authorDateFlag )
{
markup( monospacedBeginTag );
}
}
/** {@inheritDoc} */
public void monospaced_()
{
if ( !authorDateFlag )
{
markup( monospacedEndTag );
}
}
/** {@inheritDoc} */
public void lineBreak()
{
markup( lineBreakElement );
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
markup( " " );
//markup( " " );
}
/** {@inheritDoc} */
public void text( String text )
{
if ( verbatimFlag )
{
verbatimContent( text );
}
else
{
content( text );
}
}
/** {@inheritDoc} */
public void comment( String comment )
{
if ( StringUtils.isNotEmpty( comment ) && comment.indexOf( "--" ) != -1 )
{
String originalComment = comment;
// http://www.w3.org/TR/2000/REC-xml-20001006#sec-comments
while ( comment.indexOf( "--" ) != -1 )
{
comment = StringUtils.replace( comment, "--", "- -" );
}
String msg = "Modified invalid comment: '" + originalComment + "' to '" + comment + "'";
logMessage( "modifiedComment", msg );
}
StringBuffer buffer = new StringBuffer( comment.length() + 9 );
buffer.append( LESS_THAN ).append( BANG ).append( MINUS ).append( MINUS ).append( SPACE );
buffer.append( comment );
buffer.append( SPACE ).append( MINUS ).append( MINUS ).append( GREATER_THAN );
markup( buffer.toString() );
}
/**
* {@inheritDoc}
*
* Unkown events just log a warning message but are ignored otherwise.
* @see org.apache.maven.doxia.sink.Sink#unknown(String,Object[],SinkEventAttributes)
*/
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
String msg = "Unknown Sink event: '" + name + "', ignoring!";
logMessage( "unknownEvent", msg );
}
// -----------------------------------------------------------------------
/**
* Write text to output, preserving white space.
*
* @param text The text to write.
*/
protected void markup( String text )
{
if ( !skip )
{
out.write( text );
}
}
/**
* Write SGML escaped text to output, not preserving white space.
*
* @param text The text to write.
*/
protected void content( String text )
{
if ( !skip )
{
out.write( HtmlTools.escapeHTML( text, true ) );
}
}
/**
* Write SGML escaped text to output, preserving white space.
*
* @param text The text to write.
*/
protected void verbatimContent( String text )
{
if ( !skip )
{
out.write( HtmlTools.escapeHTML( text, true ) );
}
}
// -----------------------------------------------------------------------
/** {@inheritDoc} */
public void flush()
{
out.flush();
}
/** {@inheritDoc} */
public void close()
{
out.close();
if ( getLog().isWarnEnabled() && this.warnMessages != null )
{
for ( Iterator it = this.warnMessages.entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
Set set = (Set) entry.getValue();
for ( Iterator it2 = set.iterator(); it2.hasNext(); )
{
String msg = (String) it2.next();
getLog().warn( msg );
}
}
this.warnMessages = null;
}
}
/** {@inheritDoc} */
protected void write( String text )
{
markup( unifyEOLs( text ) );
}
/**
*
Setter for the field skip.
*
* @param skip the skip to set.
* @since 1.1
*/
public void setSkip( boolean skip )
{
this.skip = skip;
}
/**
* If debug mode is enabled, log the msg as is, otherwise add unique msg in warnMessages.
*
* @param key not null
* @param msg not null
* @see #close()
* @since 1.1.1
*/
private void logMessage( String key, String msg )
{
msg = "[Docbook Sink] " + msg;
if ( getLog().isDebugEnabled() )
{
getLog().debug( msg );
return;
}
if ( warnMessages == null )
{
warnMessages = new HashMap();
}
Set set = (Set) warnMessages.get( key );
if ( set == null )
{
set = new TreeSet();
}
set.add( msg );
warnMessages.put( key, set );
}
}
././@LongLink 0000000 0000000 0000000 00000000201 00000000000 011556 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/docbook/DocBookSiteModule.java doxia-1.1.4/doxia-modules/doxia-module-docbook-simple/src/main/java/org/apache/maven/doxia/module/do0000644 0001750 0001750 00000002617 11212745470 033326 0 ustar twerner twerner package org.apache.maven.doxia.module.docbook;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
*
header
example cell with colspan 1 and rowspan 2
1.1
2.1
1.2
2.2
cell test1
big cell
cell test2
blah blah blah blah blah blah blaah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah
<chunk font="Helvetica" size="18.0" fontstyle="normal" red="0" green="64" blue="64">This is subsection 2 of section 3</chunk>
blah blah blah blah blah blah blaah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah
<chunk font="Helvetica" size="18.0" fontstyle="normal" red="0" green="64" blue="64">This is subsection 3 of section 3</chunk>
blah blah blah blah blah blah blaah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah blah
blah blah blah blah blah blah blah blah blah blah blah blah
doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/ 0000755 0001750 0001750 00000000000 11632765555 023561 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765555 024350 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765555 025571 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765555 026677 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765555 030003 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765555 031270 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ 0000755 0001750 0001750 00000000000 11632765555 032425 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextSinkTestCase.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000010635 11211462442 033370 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.Writer;
import java.net.URL;
import java.net.URLClassLoader;
import org.apache.maven.doxia.AbstractModuleTest;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkTestDocument;
/**
* iText Sink Test case.
*
* @author Vincent Siveton
* @version $Id: ITextSinkTestCase.java 781348 2009-06-03 11:57:22Z vsiveton $
*/
public class ITextSinkTestCase
extends AbstractModuleTest
{
/** {@inheritDoc} */
protected String outputExtension()
{
return "xml";
}
/** {@inheritDoc} */
protected String getOutputDir()
{
return "sink/";
}
/**
* Convenience method
*
* @param prefix
* @param suffix
* @return the input file
*/
protected File getGeneratedFile( String prefix, String suffix )
{
File outputDirectory = new File( getBasedir(), outputBaseDir() + getOutputDir() );
if ( !outputDirectory.exists() )
{
outputDirectory.mkdirs();
}
return new File( outputDirectory, prefix + "." + suffix );
}
protected Sink createSink( Writer writer )
{
ITextSink sink = new ITextSink( writer );
sink.setClassLoader( new URLClassLoader(
new URL[] { ITextSinkTestCase.class.getResource( "/images/" ) } ) );
return sink;
}
/**
* Test PDF generation
*
* @throws Exception
*/
public void testGeneratingPDFFromITextXml()
throws Exception
{
File f = new File( getBasedir(), "src/test/resources/itext/itext.xml" );
ITextUtil.writePdf( new FileInputStream( f ),
new FileOutputStream( getGeneratedFile( "test_itext", "pdf" ) ) );
}
/**
* Generate a pdf and a rtf from the standart test model.
*
* @throws Exception if any
*/
public void testModel()
throws Exception
{
Sink sink = createSink( getXmlTestWriter( "test_model", "xml" ) );
SinkTestDocument.generate( sink );
sink.close();
ITextUtil.writePdf( new FileInputStream( getGeneratedFile( "test_model", "xml" ) ),
new FileOutputStream( getGeneratedFile( "test_model", "pdf" ) ) );
ITextUtil.writeRtf( new FileInputStream( getGeneratedFile( "test_model", "xml" ) ),
new FileOutputStream( getGeneratedFile( "test_model", "rtf" ) ) );
}
/**
* Test empty anchor DOXIA-329
* @throws Exception if any
*/
public void testEmptyAnchor()
throws Exception
{
Sink sink = createSink( getXmlTestWriter( "empty_anchor", "xml" ) );
SinkTestDocument.generateHead( sink );
sink.body();
sink.anchor( "empty_local_anchor" );
sink.anchor_();
sink.lineBreak();
sink.link( "#empty_local_anchor" );
sink.text( "link to empty local anchor" );
sink.link_();
sink.lineBreak();
sink.anchor( "defined_local_anchor" );
sink.text( "defined local anchor" );
sink.anchor_();
sink.lineBreak();
sink.link( "#defined_local_anchor" );
sink.text( "link to defined local anchor" );
sink.link_();
sink.body_();
sink.flush();
sink.close();
ITextUtil.writePdf( new FileInputStream( getGeneratedFile( "empty_anchor", "xml" ) ),
new FileOutputStream( getGeneratedFile( "empty_anchor", "pdf" ) ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000162 00000000000 011564 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/ITextUtilTest.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/test/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000007431 11213204343 033364 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Locale;
import junit.framework.TestCase;
import com.lowagie.text.PageSize;
/**
* @author Vincent Siveton
* @version $Id: ITextUtilTest.java 782608 2009-06-08 12:49:39Z vsiveton $
*/
public class ITextUtilTest
extends TestCase
{
public void testGetDefaultPageSize()
throws Exception
{
Locale oldLocale = Locale.getDefault();
try
{
Locale.setDefault( Locale.US );
assertEquals( PageSize.LETTER, ITextUtil.getDefaultPageSize() );
Locale.setDefault( Locale.CANADA );
assertEquals( PageSize.LETTER, ITextUtil.getDefaultPageSize() );
Locale.setDefault( Locale.FRANCE );
assertEquals( PageSize.A4, ITextUtil.getDefaultPageSize() );
}
finally
{
Locale.setDefault( oldLocale );
}
}
public void testGetPageSize()
throws Exception
{
assertEquals( "A0", ITextUtil.getPageSize( PageSize.A0 ) );
assertEquals( "A1", ITextUtil.getPageSize( PageSize.A1 ) );
assertEquals( "A2", ITextUtil.getPageSize( PageSize.A2 ) );
assertEquals( "A3", ITextUtil.getPageSize( PageSize.A3 ) );
assertEquals( "A4", ITextUtil.getPageSize( PageSize.A4 ) );
assertEquals( "A5", ITextUtil.getPageSize( PageSize.A5 ) );
assertEquals( "A6", ITextUtil.getPageSize( PageSize.A6 ) );
assertEquals( "A7", ITextUtil.getPageSize( PageSize.A7 ) );
assertEquals( "A8", ITextUtil.getPageSize( PageSize.A8 ) );
assertEquals( "A9", ITextUtil.getPageSize( PageSize.A9 ) );
assertEquals( "A10", ITextUtil.getPageSize( PageSize.A10 ) );
assertEquals( "LETTER", ITextUtil.getPageSize( PageSize.LETTER ) );
assertEquals( "LEGAL", ITextUtil.getPageSize( PageSize.LEGAL ) );
}
public void testIsPageSupported()
throws Exception
{
assertEquals( true, ITextUtil.isPageSizeSupported( "A0" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A1" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A2" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A3" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A4" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A5" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A6" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A7" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A8" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A9" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "A10" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "LETTER" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "letter" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "LEGAL" ) );
assertEquals( true, ITextUtil.isPageSizeSupported( "legal" ) );
}
}
doxia-1.1.4/doxia-modules/doxia-module-itext/src/site/ 0000755 0001750 0001750 00000000000 11632765556 022626 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 024273 0 ustar twerner twerner
doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/ 0000755 0001750 0001750 00000000000 11632765556 022606 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/ 0000755 0001750 0001750 00000000000 11632765556 023527 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765556 024316 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765556 025537 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765556 026645 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765556 027751 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765556 031236 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ 0000755 0001750 0001750 00000000000 11632765556 032373 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSinkFactory.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000004530 11216135717 033341 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractTextSinkFactory;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.WriterFactory;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
/**
* IText implementation of the Sink factory.
*
* @author Vincent Siveton
* @version $Id: ITextSinkFactory.java 785531 2009-06-17 09:47:59Z ltheussl $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="itext"
*/
public class ITextSinkFactory
extends AbstractTextSinkFactory
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding )
{
return new ITextSink( writer, encoding );
}
/**
* createSink.
*
* @param writer a {@link java.io.Writer} object.
* @return a {@link org.apache.maven.doxia.sink.Sink} object.
*/
public Sink createSink( Writer writer )
{
// TODO: should this method be deprecated?
return createSink( writer, WriterFactory.UTF_8 );
}
/**
* Create a Sink into a PrettyPrintXMLWriter.
*
* @param xmlWriter not null XML writer to write the result.
* @return a Sink instance.
*/
public Sink createSink( PrettyPrintXMLWriter xmlWriter )
{
if ( xmlWriter == null )
{
throw new IllegalArgumentException( "xmlWriter could not be null." );
}
return new ITextSink( xmlWriter );
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextUtil.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000013424 11451326654 033346 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import com.lowagie.text.DocumentException;
import com.lowagie.text.PageSize;
import com.lowagie.text.Rectangle;
import com.lowagie.text.xml.XmlToHtml;
import com.lowagie.text.xml.XmlToPdf;
import com.lowagie.text.xml.XmlToRtf;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.reflect.Field;
import java.util.Locale;
/**
* A set of util methods for the iText framework
*
* @author Vincent Siveton
* @version $Id: ITextUtil.java 1003453 2010-10-01 09:45:16Z ltheussl $
*/
public class ITextUtil
{
/**
* Set the default page size for the document depending the user's country.
* TODO Maybe more generic?
*
* @return the page size
* @see com.lowagie.text.PageSize
*/
public static Rectangle getDefaultPageSize()
{
String defaultCountry = Locale.getDefault().getCountry();
if ( defaultCountry != null
&& ( defaultCountry.equals( Locale.US.getCountry() )
|| defaultCountry.equals( Locale.CANADA.getCountry() ) ) )
{
return PageSize.LETTER;
}
return PageSize.A4;
}
/**
* Return a page size as String.
*
* @param rect a Rectangle defined in {@link PageSize}.
* @return a page size as String or A4 if not found.
* @see com.lowagie.text.PageSize
*/
public static String getPageSize( Rectangle rect )
{
Field[] fields = PageSize.class.getFields();
for ( int i = 0; i < fields.length; i++ )
{
Field currentField = fields[i];
try
{
if ( currentField.getType().equals( Rectangle.class ) )
{
Rectangle fPageSize = (Rectangle) currentField.get( null );
if ( ( rect.width() == fPageSize.width() ) && ( rect.height() == fPageSize.height() ) )
{
return currentField.getName();
}
}
}
catch ( Exception e )
{
// nop
}
}
return "A4";
}
/**
* Return true if the page size is supported by {@link PageSize} class, false otherwise.
*
* @param aPageSize a page size
* @return true if the page size is supported, false otherwise
* @see com.lowagie.text.PageSize
*/
public static boolean isPageSizeSupported( String aPageSize )
{
Field[] fields = PageSize.class.getFields();
for ( int i = 0; i < fields.length; i++ )
{
Field currentField = fields[i];
if ( ( currentField.getName().equalsIgnoreCase( aPageSize ) )
&& ( currentField.getType().equals( Rectangle.class ) ) )
{
return true;
}
}
return false;
}
/**
* Parse an iText XML from the specified InputStream, writing an Pdf document
* specified OutputStream.
*
* @param is the InputStream from which the XML is read.
* @param os the OutputStream to which the result as Pdf is written.
* @see com.lowagie.text.xml.XmlToPdf
*/
public static void writePdf( InputStream is, OutputStream os )
{
try
{
XmlToPdf x = new XmlToPdf();
x.parse( is, os );
}
catch ( DocumentException e )
{
throw new RuntimeException( "DocumentException : " + e.getMessage(), e );
}
}
/**
* Parse an iText XML from the specified InputStream, writing an rtf document
* specified OutputStream.
*
* @param is the InputStream from which the XML is read.
* @param os the OutputStream to which the result as RTF is written.
* @see com.lowagie.text.xml.XmlToRtf
*/
public static void writeRtf( InputStream is, OutputStream os )
{
try
{
XmlToRtf x = new XmlToRtf();
x.parse( is, os );
}
catch ( DocumentException e )
{
throw new RuntimeException( "DocumentException : " + e.getMessage(), e );
}
}
/**
* Parse an iText XML from the specified InputStream, writing an html document
* specified OutputStream.
*
* @param is the InputStream from which the XML is read.
* @param os the OutputStream to which the result as Html is written.
* @see com.lowagie.text.xml.XmlToHtml
*/
public static void writeHtml( InputStream is, OutputStream os )
{
try
{
XmlToHtml x = new XmlToHtml();
x.parse( is, os );
}
catch ( DocumentException e )
{
throw new RuntimeException( "DocumentException : " + e.getMessage(), e );
}
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/SinkActionContext.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/SinkA0000644 0001750 0001750 00000012330 11216135717 033306 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Stack;
/**
*
SinkActionContext class.
*
* @author Jason van Zyl
* @version $Id: SinkActionContext.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public class SinkActionContext
{
/** Constant TITLE=0 */
public static final int TITLE = 0;
/** Constant AUTHOR=1 */
public static final int AUTHOR = 1;
/** Constant DATE=2 */
public static final int DATE = 2;
/** Constant HEAD=3 */
public static final int HEAD = 3;
/** Constant BODY=4 */
public static final int BODY = 4;
/** Constant SECTION_TITLE=10 */
public static final int SECTION_TITLE = 10;
/** Constant SECTION_TITLE_1=11 */
public static final int SECTION_TITLE_1 = 11;
/** Constant SECTION_TITLE_2=12 */
public static final int SECTION_TITLE_2 = 12;
/** Constant SECTION_TITLE_3=13 */
public static final int SECTION_TITLE_3 = 13;
/** Constant SECTION_TITLE_4=14 */
public static final int SECTION_TITLE_4 = 14;
/** Constant SECTION_TITLE_5=15 */
public static final int SECTION_TITLE_5 = 15;
/** Constant SECTION_1=20 */
public static final int SECTION_1 = 20;
/** Constant SECTION_2=21 */
public static final int SECTION_2 = 21;
/** Constant SECTION_3=22 */
public static final int SECTION_3 = 22;
/** Constant SECTION_4=23 */
public static final int SECTION_4 = 23;
/** Constant SECTION_5=24 */
public static final int SECTION_5 = 24;
/** Constant DEFINITION_LIST=30 */
public static final int DEFINITION_LIST = 30;
/** Constant DEFINITION_LIST_ITEM=31 */
public static final int DEFINITION_LIST_ITEM = 31;
/** Constant DEFINED_TERM=32 */
public static final int DEFINED_TERM = 32;
/** Constant LIST_ITEM=40 */
public static final int LIST_ITEM = 40;
/** Constant NUMBERED_LIST_ITEM=41 */
public static final int NUMBERED_LIST_ITEM = 41;
/** Constant NUMBERED_LIST=42 */
public static final int NUMBERED_LIST = 42;
/** Constant DEFINITION=43 */
public static final int DEFINITION = 43;
/** Constant PARAGRAPH=44 */
public static final int PARAGRAPH = 44;
/** Constant LIST=45 */
public static final int LIST = 45;
/** Constant TABLE=50 */
public static final int TABLE = 50;
/** Constant TABLE_CAPTION=51 */
public static final int TABLE_CAPTION = 51;
/** Constant TABLE_CELL=52 */
public static final int TABLE_CELL = 52;
/** Constant TABLE_HEADER_CELL=53 */
public static final int TABLE_HEADER_CELL = 53;
/** Constant TABLE_ROW=54 */
public static final int TABLE_ROW = 54;
/** Constant TABLE_ROWS=55 */
public static final int TABLE_ROWS = 55;
/** Constant VERBATIM=60 */
public static final int VERBATIM = 60;
/** Constant FIGURE=70 */
public static final int FIGURE = 70;
/** Constant FIGURE_CAPTION=71 */
public static final int FIGURE_CAPTION = 71;
/** Constant FIGURE_GRAPHICS=72 */
public static final int FIGURE_GRAPHICS = 72;
/** Constant LINK=80 */
public static final int LINK = 80;
/** Constant ANCHOR=81 */
public static final int ANCHOR = 81;
/** Constant UNDEFINED=82 */
public static final int UNDEFINED = 82;
private Stack stack = new Stack();
private int currentAction;
/**
*
Getter for the field currentAction.
*
* @return a int.
*/
public int getCurrentAction()
{
//return currentAction;
if ( stack.empty() )
{
return UNDEFINED;
}
else
{
return ( (Integer) stack.peek() ).intValue();
}
}
/**
* release.
*/
public void release()
{
//currentAction = -1;
stack.pop();
}
/**
* setAction.
*
* @param action a int.
*/
public void setAction( int action )
{
//currentAction = action;
stack.push( new Integer( action ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextHeader.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000005766 11167436114 033355 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Date;
/**
* Header object containing meta-informations.
*
* @author Vincent Siveton
* @version $Id: ITextHeader.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class ITextHeader
{
private String title;
private StringBuffer authors;
private Date date;
/**
* Default constructor
*/
public ITextHeader()
{
// nop
}
/**
* Add a title to the Document
*
* @param title1 the title.
*/
public final void setTitle( String title1 )
{
this.title = title1;
}
/**
* Get the title
*
* @return title as String
*/
public String getTitle()
{
if ( this.title == null )
{
return "";
}
return this.title;
}
/**
* Add a new author
*
* @param author the author.
*/
public void addAuthor( String author )
{
if ( this.authors == null )
{
this.authors = new StringBuffer();
}
else
{
this.authors.append( ", " );
}
this.authors.append( author );
}
/**
* Get the authors
*
* @return the authors as String
*/
public String getAuthors()
{
if ( ( this.authors == null ) || ( this.authors.length() == 0 ) )
{
return System.getProperty( "user.name" );
}
return this.authors.toString();
}
/**
* Add a date to the document
*
* @param date1 a date as String
*/
public void setDate( String date1 )
{
try
{
this.date = new SimpleDateFormat().parse( date1 );
}
catch ( ParseException e )
{
this.date = new Date();
}
}
/**
* Get the date of the document
*
* @return the date as String
*/
public String getDate()
{
if ( this.date == null )
{
return new Date( System.currentTimeMillis() ).toString();
}
return this.date.toString();
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextFont.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000022330 11167436114 033337 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.awt.Color;
import com.lowagie.text.ExceptionConverter;
import com.lowagie.text.Font;
import com.lowagie.text.FontFactory;
import com.lowagie.text.markup.MarkupTags;
import com.lowagie.text.pdf.BaseFont;
/**
* iText wrapper object for font.
*
* @see com.lowagie.text.Font
*
* @author Vincent Siveton
* @version $Id: ITextFont.java 763762 2009-04-09 18:19:56Z ltheussl $
*/
public class ITextFont
{
/** A normal font style */
public static final String NORMAL = MarkupTags.CSS_VALUE_NORMAL;
/** A bold font style */
public static final String BOLD = MarkupTags.CSS_VALUE_BOLD;
/** A italic font style */
public static final String ITALIC = MarkupTags.CSS_VALUE_ITALIC;
/** An underline font style */
public static final String UNDERLINE = MarkupTags.CSS_VALUE_UNDERLINE;
/** A default font name */
public static final String DEFAULT_FONT_NAME = FontFactory.HELVETICA;
/** A default font size */
public static final float DEFAULT_FONT_SIZE = 12;
/** A default font style */
public static final String DEFAULT_FONT_STYLE = NORMAL;
/** A default Black color definition */
public static final int DEFAULT_FONT_COLOR_RED = Color.BLACK.getRed();
/** A default Black color definition */
public static final int DEFAULT_FONT_COLOR_GREEN = Color.BLACK.getGreen();
/** A default Black color definition */
public static final int DEFAULT_FONT_COLOR_BLUE = Color.BLACK.getBlue();
private static final int SECTION_FONT_SIZE_0 = 24;
private static final int SECTION_FONT_SIZE_1 = 22;
private static final int SECTION_FONT_SIZE_2 = 20;
private static final int SECTION_FONT_SIZE_3 = 18;
private static final int SECTION_FONT_SIZE_4 = 16;
private static final int SECTION_FONT_SIZE_DEFAULT = 14;
private boolean monoSpaced = false;
private float currentSize = 12;
private int currentStyle = Font.NORMAL;
private Color currentColor = Color.BLACK;
/**
* Default constructor
*/
public ITextFont()
{
// nop
}
/**
* Add bold style to the current style
*/
public void addBold()
{
this.currentStyle += Font.BOLD;
}
/**
* Remove bold style to the current style
*/
public void removeBold()
{
this.currentStyle -= Font.BOLD;
if ( this.currentStyle < 0 )
{
this.currentStyle = Font.NORMAL;
}
}
/**
* Add italic style to the current style
*/
public void addItalic()
{
this.currentStyle += Font.ITALIC;
}
/**
* Remove italic style to the current style
*/
public void removeItalic()
{
this.currentStyle -= Font.ITALIC;
if ( this.currentStyle < 0 )
{
this.currentStyle = Font.NORMAL;
}
}
/**
* Add italic style to the current style
*/
public void addUnderlined()
{
this.currentStyle += Font.UNDERLINE;
}
/**
* Remove italic style to the current style
*/
public void removeUnderlined()
{
this.currentStyle -= Font.UNDERLINE;
if ( this.currentStyle < 0 )
{
this.currentStyle = Font.NORMAL;
}
}
/**
* Add monospaced style to the current style
*
* @param monoSpaced true for monospaced style
*/
public void setMonoSpaced( boolean monoSpaced )
{
this.monoSpaced = monoSpaced;
}
/**
* Set a new font color
*
* @param color a new color
*/
public void setColor( Color color )
{
this.currentColor = color;
}
/**
* Set a new font color
*
* @param size a new size
*/
public void setSize( float size )
{
this.currentSize = size;
}
/**
* Return the font name
*
* @return the font name
*/
public String getFontName()
{
Font font = getCurrentFont();
return font.getFamilyname();
}
/**
* Return the font style
*
* @return the font style
*/
public String getFontStyle()
{
Font font = getCurrentFont();
StringBuffer sb = new StringBuffer();
if ( font.isBold() )
{
sb.append( BOLD );
}
if ( font.isItalic() )
{
if ( sb.length() == 0 )
{
sb.append( ITALIC );
}
else
{
sb.append( "," );
sb.append( ITALIC );
}
}
if ( font.isUnderlined() )
{
if ( sb.length() == 0 )
{
sb.append( UNDERLINE );
}
else
{
sb.append( "," );
sb.append( UNDERLINE );
}
}
if ( sb.length() == 0 )
{
return NORMAL;
}
return sb.toString();
}
/**
* Return the font name
*
* @return the font name
*/
public String getFontSize()
{
Font font = getCurrentFont();
return String.valueOf( font.getCalculatedSize() );
}
/**
* Return the font color blue
*
* @return the font color blue
*/
public String getFontColorBlue()
{
Font font = getCurrentFont();
return String.valueOf( font.color().getBlue() );
}
/**
* Return the font color green
*
* @return the font color green
*/
public String getFontColorGreen()
{
Font font = getCurrentFont();
return String.valueOf( font.color().getGreen() );
}
/**
* Return the font color red
*
* @return the font color red
*/
public String getFontColorRed()
{
Font font = getCurrentFont();
return String.valueOf( font.color().getRed() );
}
/**
* Get a section font size depending the section number.
*
*
0
*
Chapter: font size = 24
*
1
*
Section 1: font size = 22
*
2
*
Section 2: font size = 20
*
3
*
Section 3: font size = 18
*
4
*
Section 4: font size = 16
*
5 ot otherwise
*
Section 5: font size = 14
*
*
* @param sectionNumber a section number
* @return a font size.
*/
public static int getSectionFontSize( int sectionNumber )
{
switch ( sectionNumber )
{
case 0:
return SECTION_FONT_SIZE_0;
case 1:
return SECTION_FONT_SIZE_1;
case 2:
return SECTION_FONT_SIZE_2;
case 3:
return SECTION_FONT_SIZE_3;
case 4:
return SECTION_FONT_SIZE_4;
case 5:
default:
return SECTION_FONT_SIZE_DEFAULT;
}
}
/**
* Convenience method to get a defined MonoSpaced font depending the wanted style and size.
*
* @param style the font style.
* @param size the font size.
* @param color the font color.
* @return a font the font.
*/
public static Font getMonoSpacedFont( int style, float size, Color color )
{
try
{
return new Font( BaseFont.createFont( BaseFont.COURIER, BaseFont.CP1252, false ), size, style, color );
}
catch ( Exception e )
{
throw new ExceptionConverter( e );
}
}
/**
* Convenience method to get a defined font depending the wanted style and size.
*
* @param style the font style.
* @param size the font size.
* @param color the font color.
* @return a font the font.
*/
public static Font getFont( int style, float size, Color color )
{
Font font = new Font();
font.setFamily( DEFAULT_FONT_NAME );
font.setStyle( style );
font.setSize( size );
font.setColor( color );
return font;
}
/**
* Convenience method to return the current font
*
* @return the current font
*/
private Font getCurrentFont()
{
if ( this.monoSpaced )
{
return getMonoSpacedFont( this.currentStyle, this.currentSize, this.currentColor );
}
return getFont( this.currentStyle, this.currentSize, this.currentColor );
}
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/ITextSink.java doxia-1.1.4/doxia-modules/doxia-module-itext/src/main/java/org/apache/maven/doxia/module/itext/IText0000644 0001750 0001750 00000157644 11451327013 033351 0 ustar twerner twerner package org.apache.maven.doxia.module.itext;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import com.lowagie.text.BadElementException;
import com.lowagie.text.ElementTags;
import com.lowagie.text.Image;
import java.awt.Color;
import java.io.File;
import java.io.IOException;
import java.io.LineNumberReader;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import org.apache.maven.doxia.sink.AbstractXmlSink;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
import org.codehaus.plexus.util.xml.XMLWriter;
/**
*
A doxia Sink which produces an XML Front End document for iText framework.
iText has some problems with ElementTags.TABLE and ElementTags.TABLEFITSPAGE.
* See http://sourceforge.net/tracker/index.php?func=detail&aid=786427&group_id=15255&atid=115255.
*
Images could be on another page and next text on the last one.
*
*
* @see http://www.lowagie.com/iText/tutorial/ch07.html
*
* @author Vincent Siveton
* @version $Id: ITextSink.java 1003454 2010-10-01 09:46:51Z ltheussl $
*/
public class ITextSink
extends AbstractXmlSink
{
/** This is the place where the iText DTD is located. IMPORTANT: this DTD is not uptodate! */
public static final String DTD = "http://itext.sourceforge.net/itext.dtd";
/** This is the reference to the DTD. */
public static final String DOCTYPE = "ITEXT SYSTEM \"" + DTD + "\"";
/** This is the default leading for chapter title */
public static final String DEFAULT_CHAPTER_TITLE_LEADING = "36.0";
/** This is the default leading for section title */
public static final String DEFAULT_SECTION_TITLE_LEADING = "24.0";
/** The ClassLoader used */
private ClassLoader currentClassLoader;
/** The action context */
private SinkActionContext actionContext;
/** The Writer used */
private Writer writer;
/** The XML Writer used */
private final XMLWriter xmlWriter;
private boolean writeStart;
/** The Header object */
private ITextHeader header;
/** The font object */
private ITextFont font;
private int numberDepth = 1;
private int depth = 0;
private StringWriter tableCaptionWriter = null;
private XMLWriter tableCaptionXMLWriter = null;
/** Flag to know if an anchor is defined or not. Used as workaround for iText which needs a defined local
* destination. */
private boolean anchorDefined = false;
/** Flag to know if an figure event is called. */
private boolean figureDefined = false;
/** Map of warn messages with a String as key to describe the error type and a Set as value.
* Using to reduce warn messages. */
private Map warnMessages;
/**
*
Maven is a software project management and comprehension tool. Based on the concept of a project object model
(POM), Maven can manage a project's build, reporting and documentation from a central piece of information.
This site is separated into the following sections, depending on how you'd like to use Maven:
Run Maven
Information for those needing to build a project that uses Maven
Use Maven
Information for those wanting to use Maven to build their project, including a "10 minute test" that gives a
practical overview of Maven's main features in just 10 minutes
Write Maven Plugins
Information for those who may or may not be using Maven, but want to provide a plugin for shared
functionality or to accompany their own product or toolset
Improve the Maven Repository
Information for those who may or may not use, but are interested in getting project metadata into the
repository
Develop Maven
Information for those who are currently developers, or interested in becoming developers of the Maven
project itself
Each guide is divided into a number of trails to get you started on a particular topic, and includes a
reference area and a "cookbook" of common examples.
You can access the guides at any time from the left navigation.
For detailed information on just some of the plugins available for Maven, see the
plugin list.
How to Get Support
Support for Maven is available in a variety of different forms.
To get started, search the documentation, the wiki,
issue tracker, or the mailing list archives to
see if the problem has been solved or reported before.
If the problem has not been reported before, the recommended way to get help is to
subscribe to the Maven Users Mailing list. Many other users and Maven developers
will answer your questions there, and the answer will be archived for others in the future.
doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/test/resources/fun.html 0000644 0001750 0001750 00000004262 10577144521 026322 0 ustar twerner twerner
This is fun!
This is the first first-level section
This paragraph belongs to section one.
This is the first second-level section
This paragraph belongs to subsection one.
This is the second second-level section
This paragraph belongs to subsection two.
This is the first third-level section
To make the taskeven harder,
the h3-heading was dropped, but we
expect the parser to recognize this section
as level 3, not level 4.
This is the third second-level section
This paragraph belongs to subsection three.
This is the second first-level section
This paragraph belongs to section two.
//what is source code?
This is also a paragraph. Take a look
at the other paragraph.
Just introduce some
images.
doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/test/resources/file.with.dot.in.name.xml 0000644 0001750 0001750 00000000012 10767706471 031366 0 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/test/resources/download.apt.vm 0000644 0001750 0001750 00000012705 10767705722 027612 0 ustar twerner twerner ------
Download Maven ${currentVersion}
------
Brett Porter
Jason van Zyl
------
4 October 2005
------
Download Maven ${currentVersion}
Maven is distributed in several formats for your convenience.
You will be prompted for a mirror - if the file is not found on yours, please be patient, as it may take 24
hours to reach all mirrors.
Maven ${currentVersion} is distributed under the {{{http://maven.apache.org/license.html} Apache License, version 2.0}}.
We <> encourage our users to configure a Maven repository mirror closer to their location, please read {{{guides/mini/guide-mirror-settings.html} How to Use Mirrors for Repositories}}.
*-------------------------+---------+----------+-----------+
| | Mirrors | Checksum | Signature |
*-------------------------+---------+----------+-----------+
| Maven ${currentVersion} (tar.bz2) | {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-${currentVersion}-bin.tar.bz2} maven-${currentVersion}-bin.tar.bz2}} | {{{http://www.apache.org/dist/maven/binaries/maven-${currentVersion}-bin.tar.bz2.md5} maven-${currentVersion}-bin.tar.bz2.md5}} | {{{http://www.apache.org/dist/maven/binaries/maven-${currentVersion}-bin.tar.bz2.asc} maven-${currentVersion}-bin.tar.bz2.asc}} |
*-------------------------+---------+----------+-----------+
| Maven ${currentVersion} (tar.gz) | {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-${currentVersion}-bin.tar.gz} maven-${currentVersion}-bin.tar.gz}} | {{{http://www.apache.org/dist/maven/binaries/maven-${currentVersion}-bin.tar.gz.md5} maven-${currentVersion}-bin.tar.gz.md5}} | {{{http://www.apache.org/dist/maven/binaries/maven-${currentVersion}-bin.tar.gz.asc} maven-${currentVersion}-bin.tar.gz.asc}} |
*-------------------------+---------+----------+-----------+
| Maven ${currentVersion} (zip) | {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-${currentVersion}-bin.zip} maven-${currentVersion}-bin.zip}} | {{{http://www.apache.org/dist/maven/binaries/maven-${currentVersion}-bin.zip.md5} maven-${currentVersion}-bin.zip.md5}} | {{{http://www.apache.org/dist/maven/binaries/maven-${currentVersion}-bin.zip.asc} maven-${currentVersion}-bin.zip.asc}} |
*-------------------------+---------+----------+-----------+
| Maven Ant Tasks 2.0.7 | {{{http://www.apache.org/dyn/closer.cgi/maven/binaries/maven-ant-tasks-2.0.7.jar} maven-ant-tasks-2.0.7.jar}} | {{{http://www.apache.org/dist/maven/binaries/maven-ant-tasks-2.0.7.jar.md5} maven-ant-tasks-2.0.7.jar.md5}} | {{{http://www.apache.org/dist/maven/binaries/maven-ant-tasks-2.0.7.jar.asc} maven-ant-tasks-2.0.7.jar.asc}} |
*-------------------------+---------+----------+-----------+
* Previous Releases
All previous releases of Maven can be found in the {{{http://archive.apache.org/dist/maven/binaries/}archives}}.
* System {Requirements}
*----------------------+---------------------------------------------------------------------------------------------+
| <> | 1.4 or above (this is to execute Maven - it still allows you to build against 1.3 and prior JDK's)
*----------------------+---------------------------------------------------------------------------------------------+
| <> | No minimum requirement
*----------------------+---------------------------------------------------------------------------------------------+
| <> | No minimum requirement. Approximately 100MB will be used for your local repository, however this will vary depending on usage and can be removed and redownloaded at any time.
*----------------------+---------------------------------------------------------------------------------------------+
| <> | No minimum requirement. On Windows, Windows NT and above or Cygwin is required for the startup scripts. Tested on Windows XP, Fedora Core and Mac OS X.
*----------------------+---------------------------------------------------------------------------------------------+
* {Installation} Instructions
** Windows 2000/XP
[[1]] Unzip <<>> to the directory you wish to install Maven ${currentVersion}. These instructions
assume you chose <<>>
[[2]] Add the <<>> directory to your path, by opening up the system properties (WinKey + Pause),
selecting the "Advanced" tab, and the "Environment Variables" button, then editing the <<>>
variable in the user variables. eg.
<<<"C:\Program Files\Apache Software Foundation\maven-${currentVersion}\bin";%PATH%>>>
[[3]] In the same dialog, make sure that <<>> is set to the location of your JDK,
eg. <<>>
[[4]] Run <<>> to verify that it is correctly installed.
** Unix-based Operating Systems (Linux, Solaris and Mac OS X)
[[1]] Extract the distribution archive to the directory you wish to install Maven ${currentVersion}. These instructions
assume you chose <<>>. The directory <<>> will be created from
the archive.
[[2]] Add the <<>> directory to your path, eg. <<>>
[[3]] Make sure that <<>> is set to the location of your JDK, eg.
<<>>
[[4]] Run <<>> to verify that it is correctly installed.
doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/test/resources/test.xhtml 0000644 0001750 0001750 00000006117 10772521335 026701 0 ustar twerner twerner
Title
Paragraph 1, line 1. Paragraph 1, line 2.
Paragraph 2, line 1. Paragraph 2, line 2.
Section title
Sub-section title
Sub-sub-section title
Sub-sub-sub-section title
Sub-sub-sub-sub-section title
List item 1.
List item 2.
Paragraph contained in list item 2.
Sub-list item 1.
Sub-list item 2.
List item 3. Force end of list:
Verbatim text not contained in list item 3
Numbered item 1.
Numbered item A.
Numbered item B.
Numbered item 2.
List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]].
Defined term 1
of definition list.
Defined term 2
of definition list.
Verbatim text
in a box
--- instead of +-- suppresses the box around verbatim text.
";
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getPageBreakBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getAnchorBlock( String anchor )
{
return "" + anchor + "";
}
/** {@inheritDoc} */
protected String getLinkBlock( String link, String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getItalicBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getBoldBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getMonospacedBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return " ";
}
/** {@inheritDoc} */
protected String getNonBreakingSpaceBlock()
{
return " ";
}
/** {@inheritDoc} */
protected String getTextBlock( String text )
{
// TODO: need to be able to retreive those from outside the sink
return "~,_=,_-,_+,_*,_[,_],_<,_>,_{,_},_\\";
}
/** {@inheritDoc} */
protected String getRawTextBlock( String text )
{
return text;
}
/**
* Test entities is section titles and paragraphs.
*/
public void testEntities()
{
XhtmlSink sink = null;
Writer writer = new StringWriter();
try
{
sink = new XhtmlSink( writer );
sink.section( Sink.SECTION_LEVEL_1, null );
sink.sectionTitle( Sink.SECTION_LEVEL_1, null );
sink.text( "&", null );
sink.sectionTitle_( Sink.SECTION_LEVEL_1 );
sink.paragraph( null );
sink.text( "&", null );
sink.paragraph_();
sink.section_( Sink.SECTION_LEVEL_1 );
}
finally
{
sink.close();
}
assertEquals( "
&
&
", writer.toString() );
}
/**
* Test head events.
*/
public void testHead()
{
XhtmlSink sink = null;
Writer writer = new StringWriter();
try
{
sink = new XhtmlSink( writer );
sink.head();
sink.title();
sink.text( "Title" );
sink.title_();
sink.comment( "A comment" );
sink.author();
// note: this is really illegal, there should be no un-resolved entities emitted into text()
sink.text( "ģ&" );
sink.author_();
sink.head_();
}
finally
{
sink.close();
}
String exp =
"Title";
assertTrue( writer.toString().indexOf( exp ) != -1 );
}
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
return "";
}
}
././@LongLink 0000000 0000000 0000000 00000000200 00000000000 011555 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/test/java/org/apache/maven/doxia/module/xhtml/XhtmlSinkWithLanguageIdTest.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/test/java/org/apache/maven/doxia/module/xhtml/Xhtml0000644 0001750 0001750 00000003374 11141061207 033423 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import java.util.Locale;
import org.apache.maven.doxia.sink.Sink;
/**
* @author Vincent Siveton
* @version $Id: XhtmlSinkWithLanguageIdTest.java 739565 2009-01-31 14:39:03Z vsiveton $
*/
public class XhtmlSinkWithLanguageIdTest
extends XhtmlSinkTest
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new XhtmlSink( writer, "UTF-8", Locale.US.getLanguage() );
}
/** {@inheritDoc} */
protected String getHeadBlock()
{
return ""
+ ""
+ ""
+ "";
}
}
doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/site/ 0000755 0001750 0001750 00000000000 11632765555 022624 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/site/site.xml 0000644 0001750 0001750 00000001672 11103330660 024272 0 ustar twerner twerner
doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/ 0000755 0001750 0001750 00000000000 11632765555 022604 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/ 0000755 0001750 0001750 00000000000 11632765555 023525 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765555 024314 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765555 025535 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765555 026643 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765555 027747 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765555 031234 5 ustar twerner twerner doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/ 0000755 0001750 0001750 00000000000 11632765555 032370 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlSink.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/Xhtml0000644 0001750 0001750 00000016776 11244503630 033407 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.html.HTML.Attribute;
import org.apache.maven.doxia.sink.XhtmlBaseSink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
/**
* Xhtml 1.0 Transitional sink implementation.
*
* It uses the DTD/xhtml1-transitional
* http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd.
*
* @author Jason van Zyl
* @author ltheussl
* @version $Id: XhtmlSink.java 807186 2009-08-24 12:29:12Z vsiveton $
* @since 1.0
*/
public class XhtmlSink
extends XhtmlBaseSink
implements XhtmlMarkup
{
// ----------------------------------------------------------------------
// Instance fields
// ----------------------------------------------------------------------
private String encoding;
private String languageId;
/** An indication on if we're inside a head title. */
private boolean headTitleFlag;
// ----------------------------------------------------------------------
// Constructors
// ----------------------------------------------------------------------
/**
* Constructor, initialize the Writer.
*
* @param writer not null writer to write the result.
*/
protected XhtmlSink( Writer writer )
{
super( writer );
}
/**
* Constructor, initialize the Writer and tells which encoding is used.
*
* @param writer not null writer to write the result.
* @param encoding the encoding used, that should be written to the generated HTML content
* if not null.
*/
protected XhtmlSink( Writer writer, String encoding )
{
super( writer );
this.encoding = encoding;
}
/**
* Constructor, initialize the Writer and tells which encoding and languageId are used.
*
* @param writer not null writer to write the result.
* @param encoding the encoding used, that should be written to the generated HTML content
* if not null.
* @param languageId language identifier for the root element as defined by
* IETF BCP 47, Tags for the Identification of Languages;
* in addition, the empty string may be specified.
*/
protected XhtmlSink( Writer writer, String encoding, String languageId )
{
this( writer, encoding );
this.languageId = languageId;
}
/** {@inheritDoc} */
public void head()
{
init();
setHeadFlag( true );
write( "" );
MutableAttributeSet atts = new SinkEventAttributeSet();
atts.addAttribute( "xmlns", XHTML_NAMESPACE );
if ( languageId != null )
{
atts.addAttribute( Attribute.LANG.toString(), languageId );
atts.addAttribute( "xml:lang", languageId );
}
writeStartTag( HTML, atts );
writeStartTag( HEAD );
}
/** {@inheritDoc} */
public void head_()
{
if ( !isHeadTitleFlag() )
{
// The content of element type "head" must match
// "((script|style|meta|link|object|isindex)*,
// ((title,(script|style|meta|link|object|isindex)*,
// (base,(script|style|meta|link|object|isindex)*)?)|(base,(script|style|meta|link|object|isindex)*,
// (title,(script|style|meta|link|object|isindex)*))))"
writeStartTag( TITLE );
writeEndTag( TITLE );
}
setHeadFlag( false );
setHeadTitleFlag( false );
if ( encoding != null )
{
write( "" );
}
writeEndTag( HEAD );
}
/**
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#TITLE
*/
public void title()
{
setHeadTitleFlag( true );
writeStartTag( TITLE );
}
/**
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#TITLE
*/
public void title_()
{
content( getTextBuffer().toString() );
writeEndTag( TITLE );
resetTextBuffer();
}
/**
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#META
*/
public void author_()
{
if ( getTextBuffer().length() > 0 )
{
MutableAttributeSet att = new SinkEventAttributeSet();
att.addAttribute( Attribute.NAME, "author" );
String text = HtmlTools.escapeHTML( getTextBuffer().toString() );
// hack: un-escape numerical entities that have been escaped above
// note that numerical entities should really be added as one unicode character in the first place
text = StringUtils.replace( text, "&#", "&#" );
att.addAttribute( Attribute.CONTENT, text );
writeSimpleTag( META, att );
resetTextBuffer();
}
}
/**
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#META
*/
public void date_()
{
if ( getTextBuffer().length() > 0 )
{
MutableAttributeSet att = new SinkEventAttributeSet();
att.addAttribute( Attribute.NAME, "date" );
att.addAttribute( Attribute.CONTENT, getTextBuffer().toString() );
writeSimpleTag( META, att );
resetTextBuffer();
}
}
/**
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#BODY
*/
public void body()
{
writeStartTag( BODY );
}
/**
* {@inheritDoc}
* @see javax.swing.text.html.HTML.Tag#BODY
* @see javax.swing.text.html.HTML.Tag#HTML
*/
public void body_()
{
writeEndTag( BODY );
writeEndTag( HTML );
flush();
init();
}
// ----------------------------------------------------------------------
// Public protected methods
// ----------------------------------------------------------------------
/**
*
*
* @return the current headTitleFlag.
* @since 1.1
*/
protected boolean isHeadTitleFlag()
{
return this.headTitleFlag ;
}
}
././@LongLink 0000000 0000000 0000000 00000000166 00000000000 011570 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/AbstractXhtmlSink.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/Abstr0000644 0001750 0001750 00000002236 11150514100 033336 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.SinkAdapter;
/**
*
Abstract AbstractXhtmlSink class.
*
* @author Jason van Zyl
* @version $Id: AbstractXhtmlSink.java 746993 2009-02-23 12:36:16Z vsiveton $
* @since 1.0
*/
public abstract class AbstractXhtmlSink
extends SinkAdapter
{
}
././@LongLink 0000000 0000000 0000000 00000000164 00000000000 011566 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlSiteModule.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/Xhtml0000644 0001750 0001750 00000002516 11212745470 033377 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.AbstractSiteModule;
/**
*
XhtmlSiteModule class.
*
* @author ltheussl
* @version $Id: XhtmlSiteModule.java 782392 2009-06-07 14:14:16Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.module.site.SiteModule" role-hint="xhtml"
*/
public class XhtmlSiteModule
extends AbstractSiteModule
{
/**
* Default constructor.
*/
public XhtmlSiteModule()
{
super( "xhtml", "xhtml", "xhtml" );
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlParser.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/Xhtml0000644 0001750 0001750 00000015170 11244503630 033372 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Attribute;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.parser.XhtmlBaseParser;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Parse an xhtml model and emit events into a Doxia Sink.
*
* @author Jason van Zyl
* @version $Id: XhtmlParser.java 807186 2009-08-24 12:29:12Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.parser.Parser" role-hint="xhtml"
*/
public class XhtmlParser
extends XhtmlBaseParser
implements XhtmlMarkup
{
/** For boxed verbatim. */
private boolean boxed;
/** Empty elements don't write a closing tag. */
private boolean isEmptyElement;
/** {@inheritDoc} */
protected void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
isEmptyElement = parser.isEmptyElementTag();
SinkEventAttributeSet attribs = getAttributesFromParser( parser );
if ( parser.getName().equals( HTML.toString() ) )
{
//Do nothing
return;
}
else if ( parser.getName().equals( HEAD.toString() ) )
{
sink.head( attribs );
}
else if ( parser.getName().equals( TITLE.toString() ) )
{
sink.title( attribs );
}
else if ( parser.getName().equals( META.toString() ) )
{
String name = parser.getAttributeValue( null, Attribute.NAME.toString() );
String content = parser.getAttributeValue( null, Attribute.CONTENT.toString() );
if ( "author".equals( name ) )
{
sink.author( null );
sink.text( content );
sink.author_();
}
else if ( "date".equals( name ) )
{
sink.date( null );
sink.text( content );
sink.date_();
}
else
{
sink.unknown( "meta", new Object[] {new Integer( TAG_TYPE_SIMPLE )}, attribs );
}
}
/*
* The ADDRESS element may be used by authors to supply contact information
* for a model or a major part of a model such as a form. This element
* often appears at the beginning or end of a model.
*/
else if ( parser.getName().equals( ADDRESS.toString() ) )
{
sink.author( attribs );
}
else if ( parser.getName().equals( BODY.toString() ) )
{
sink.body( attribs );
}
else if ( parser.getName().equals( DIV.toString() ) )
{
String divclass = parser.getAttributeValue( null, Attribute.CLASS.toString() );
if ( "source".equals( divclass ) )
{
this.boxed = true;
}
super.baseStartTag( parser, sink ); // pick up other divs
}
/*
* The PRE element tells visual user agents that the enclosed text is
* "preformatted". When handling preformatted text, visual user agents:
* - May leave white space intact.
* - May render text with a fixed-pitch font.
* - May disable automatic word wrap.
* - Must not disable bidirectional processing.
* Non-visual user agents are not required to respect extra white space
* in the content of a PRE element.
*/
else if ( parser.getName().equals( PRE.toString() ) )
{
if ( boxed )
{
attribs.addAttributes( SinkEventAttributeSet.BOXED );
}
verbatim();
sink.verbatim( attribs );
}
else if ( !baseStartTag( parser, sink ) )
{
if ( isEmptyElement )
{
handleUnknown( parser, sink, TAG_TYPE_SIMPLE );
}
else
{
handleUnknown( parser, sink, TAG_TYPE_START );
}
if ( getLog().isDebugEnabled() )
{
String position = "[" + parser.getLineNumber() + ":"
+ parser.getColumnNumber() + "]";
String tag = "<" + parser.getName() + ">";
getLog().debug( "Unrecognized xhtml tag: " + tag + " at " + position );
}
}
}
/** {@inheritDoc} */
protected void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( parser.getName().equals( HTML.toString() ) )
{
//Do nothing
return;
}
else if ( parser.getName().equals( HEAD.toString() ) )
{
sink.head_();
}
else if ( parser.getName().equals( TITLE.toString() ) )
{
sink.title_();
}
else if ( parser.getName().equals( BODY.toString() ) )
{
consecutiveSections( 0, sink );
sink.body_();
}
else if ( parser.getName().equals( ADDRESS.toString() ) )
{
sink.author_();
}
else if ( parser.getName().equals( DIV.toString() ) )
{
this.boxed = false;
super.baseEndTag( parser, sink );
}
else if ( !baseEndTag( parser, sink ) )
{
if ( !isEmptyElement )
{
handleUnknown( parser, sink, TAG_TYPE_END );
}
}
isEmptyElement = false;
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.boxed = false;
this.isEmptyElement = false;
}
}
././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlMarkup.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/Xhtml0000644 0001750 0001750 00000003406 11141054030 033360 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.markup.HtmlMarkup;
/**
* List of Xhtml markups.
*
* Xhtml uses all {@link javax.swing.text.html.HTML.Tag} and {@link javax.swing.text.html.HTML.Attribute}
* as markups.
*
* @author Vincent Siveton
* @version $Id: XhtmlMarkup.java 739557 2009-01-31 13:54:32Z vsiveton $
* @since 1.0
*/
public interface XhtmlMarkup
extends HtmlMarkup
{
/** XHTML namespace: "http://www.w3.org/1999/xhtml" */
String XHTML_NAMESPACE = "http://www.w3.org/1999/xhtml";
/** XHTML 1.0 transitional public id: "-//W3C//DTD XHTML 1.0 Transitional//EN" */
String XHTML_TRANSITIONAL_PUBLIC_ID = "-//W3C//DTD XHTML 1.0 Transitional//EN";
/** XHTML 1.0 transitional system id: "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd" */
String XHTML_TRANSITIONAL_SYSTEM_ID = "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd";
}
././@LongLink 0000000 0000000 0000000 00000000165 00000000000 011567 L ustar root root doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/XhtmlSinkFactory.java doxia-1.1.4/doxia-modules/doxia-module-xhtml/src/main/java/org/apache/maven/doxia/module/xhtml/Xhtml0000644 0001750 0001750 00000003233 11141061207 033362 0 ustar twerner twerner package org.apache.maven.doxia.module.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import org.apache.maven.doxia.sink.AbstractXmlSinkFactory;
import org.apache.maven.doxia.sink.Sink;
/**
* Xhtml implementation of the Sink factory.
*
* @author Vincent Siveton
* @version $Id: XhtmlSinkFactory.java 739565 2009-01-31 14:39:03Z vsiveton $
* @since 1.0
* @plexus.component role="org.apache.maven.doxia.sink.SinkFactory" role-hint="xhtml"
*/
public class XhtmlSinkFactory
extends AbstractXmlSinkFactory
{
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding )
{
return new XhtmlSink( writer, encoding );
}
/** {@inheritDoc} */
protected Sink createSink( Writer writer, String encoding, String languageId )
{
return new XhtmlSink( writer, encoding, languageId );
}
}
doxia-1.1.4/doxia-book/ 0000755 0001750 0001750 00000000000 11632765560 014626 5 ustar twerner twerner doxia-1.1.4/doxia-book/pom.xml 0000644 0001750 0001750 00000011023 11470562366 016137 0 ustar twerner twerner
4.0.0org.apache.maven.doxiadoxia1.1.4../pom.xmldoxia-bookDoxia :: Book ComponentA component to write books like user manuals and guides in any format supported by Doxia.org.apache.maven.doxiadoxia-coreorg.apache.maven.doxiadoxia-sink-apiorg.apache.maven.doxiadoxia-module-aptorg.apache.maven.doxiadoxia-module-docbook-simpleorg.apache.maven.doxiadoxia-module-itextorg.apache.maven.doxiadoxia-module-latexorg.apache.maven.doxiadoxia-module-xdocorg.apache.maven.doxiadoxia-module-xhtmlorg.codehaus.plexusplexus-container-defaultorg.codehaus.plexusplexus-i18n1.0-beta-6org.codehaus.plexusplexus-utilsorg.apache.maven.doxiadoxia-coretest-jartestorg.codehaus.modellomodello-maven-pluginsrc/main/modello/book.mdo1.0.0site-docspre-sitexdocxsddescriptorgenerate-sourcesjavaxpp3-readerxsdreportingorg.codehaus.mojol10n-maven-plugin1.0-alpha-2enfr doxia-1.1.4/doxia-book/src/ 0000755 0001750 0001750 00000000000 11632765560 015415 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/ 0000755 0001750 0001750 00000000000 11632765560 016374 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765560 020406 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/resources/book-1.xml 0000644 0001750 0001750 00000003044 11137600663 022211 0 ustar twerner twerner
plexus-user-guideTest Bookchapter-1Chapter 1section-1section-2chapter-2Chapter 2section-3section-4
doxia-1.1.4/doxia-book/src/test/resources/book-1/ 0000755 0001750 0001750 00000000000 11632765560 021476 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/resources/book-1/section-4.apt 0000644 0001750 0001750 00000001716 10524215463 024005 0 ustar twerner twerner -----
Section 4
-----
Trygve
-----
Section 1.10.33 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC
At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque
corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa
qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita
distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime
placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut
officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae.
Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut
perferendis doloribus asperiores repellat.
doxia-1.1.4/doxia-book/src/test/resources/book-1/section-2.apt 0000644 0001750 0001750 00000001743 10524215463 024003 0 ustar twerner twerner -----
Section 2
-----
Trygve
-----
Section 1.10.32 of "de Finibus Bonorum et Malorum", written by Cicero in 45 BC
Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam,
eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam
voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione
voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci
velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim
ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi
consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur,
vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?
doxia-1.1.4/doxia-book/src/test/resources/book-1/section-1.apt 0000644 0001750 0001750 00000010200 10524215463 023766 0 ustar twerner twerner -----
Section 1
-----
Trygve
-----
Subsection 1
Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec sagittis malesuada nisi. Aliquam orci eros, vestibulum
eu, placerat et, pretium sed, nisi. Proin consequat. Praesent faucibus sem id arcu hendrerit nonummy. Aliquam blandit
accumsan pede. Vivamus aliquet lacinia nunc. Praesent dapibus orci eu magna. Cras nonummy, pede nec facilisis semper,
sem nibh vestibulum massa, sed ornare tortor elit non lectus. Nullam mauris turpis, luctus et, vulputate vitae, commodo
sit amet, purus. Fusce erat. Proin ullamcorper imperdiet est. Morbi sit amet dui. Fusce bibendum auctor augue. Sed leo
sapien, vehicula ac, nonummy id, cursus at, nulla. Ut sed purus.
* Subsubsection 1
Suspendisse sagittis metus nec leo. Suspendisse velit. Phasellus ipsum dolor, porttitor ut1, varius id, scelerisque
vel, ligula. Aliquam tempor sem in pede tincidunt nonummy. Vestibulum et nulla. Nunc et dolor a risus porttitor tem
pus. Sed felis arcu, consectetuer non, imperdiet sollicitudin, ullamcorper vitae, nulla. Vestibulum ante ipsum primis
in faucibus.
Subsection 2
Duis eget libero aliquet quam ultrices malesuada. Donec molestie dignissim nunc. Curabitur turpis. Suspendisse a nibh
ut elit vulputate ultrices. Etiam nulla erat, nonummy vel, fringilla at, scelerisque non, ante. Suspendisse adipiscing
rhoncus purus. Nulla in augue. Ut ac nisi eu nisi cursus elementum. Pellentesque habitant morbi tristique senectus et
netus et malesuada fames ac turpis egestas. Donec et turpis. Donec nec mi. Mauris malesuada congue sem. Maecenas et
urna in nisi sagittis facilisis. Cras nibh. Aliquam purus. Donec convallis congue libero. Nulla feugiat. Nulla massa
libero, consectetuer ac, aliquet ac, consequat eu, purus. Pellentesque eleifend pretium augue.
Subsection 3
Integer auctor, nisi ut convallis imperdiet, ligula diam sollicitudin dolor, porttitor mattis urna sapien at velit.
Fusce vestibulum, neque nec malesuada tempor, tortor nisi accumsan purus, quis faucibus metus elit ac urna. Aliquam
commodo velit vel ipsum. Donec blandit diam blandit eros. Aliquam pretium fermentum neque. Sed nec tellus eu orci
ullamcorper facilisis. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas.
Nulla sed leo. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Fusce
suscipit. Sed sit amet diam ac ante tincidunt ornare. Sed sodales vestibulum quam. Fusce accumsan. Ut ut mi.
Subsection 4
Maecenas tincidunt lobortis nunc. Phasellus euismod diam sit amet felis. Donec lorem metus, vulputate vitae, ornare
vel, molestie sit amet, pede. In erat velit, adipiscing sed, varius in, interdum cursus, enim. Quisque dolor ante,
tincidunt vel, congue eget, consectetuer id, nunc. Suspendisse hendrerit. Proin egestas, massa eget egestas
ullamcorper, nisl elit gravida magna, vitae dignissim odio velit ut tortor. Fusce lobortis consequat nulla.
Vestibulum pretium justo at metus. Sed lorem velit, elementum eget, pellentesque ac, ornare id, mi. Pellentesque vel
ligula et erat dictum commodo. Integer malesuada lacus nec metus. Aliquam id purus ac neque mattis venenatis. Aenean
lobortis accumsan massa. Donec dui ante, facilisis vel, hendrerit ut, vehicula in, eros. Suspendisse potenti. Sed
fringilla. Suspendisse vel nibh. Sed sit amet lacus quis massa tincidunt elementum. Ut ut augue vitae ligula dapibus
aliquam.
Subsection 5
Fusce non eros non lectus venenatis bibendum. Nullam pharetra. Nunc commodo pede et metus. Pellentesque habitant morbi
tristique senectus et netus et malesuada fames ac turpis egestas. Vestibulum imperdiet nisl nec nulla. Morbi congue
dictum pede. Aliquam ligula. In pede nulla, varius a, blandit ut, pulvinar vitae, mauris. Suspendisse sit amet magna.
Curabitur cursus placerat justo. Vivamus imperdiet magna commodo mi. Vestibulum eget metus quis sem sollicitudin
consectetuer. Morbi metus augue, elementum rutrum, luctus quis, porttitor a, est. Phasellus quis sapien et augue
adipiscing fermentum. Sed fermentum tristique dui. Vivamus aliquam, tortor at ultricies commodo, urna ipsum fringilla
neque, sit amet congue purus enim a justo.
doxia-1.1.4/doxia-book/src/test/resources/book-1/section-3.apt 0000644 0001750 0001750 00000002035 10524215463 023777 0 ustar twerner twerner -----
Section 3
-----
Trygve
-----
1914 translation by H. Rackham
But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will
give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the
master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but
because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful.
Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because
occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial
example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who
has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who
avoids a pain that produces no resultant pleasure?
doxia-1.1.4/doxia-book/src/test/resources/expected/ 0000755 0001750 0001750 00000000000 11632765560 022207 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/resources/expected/doc-book/ 0000755 0001750 0001750 00000000000 11632765560 023704 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/resources/expected/doc-book/plexus-user-guide.xml 0000644 0001750 0001750 00000017074 11141050701 030001 0 ustar twerner twerner
Test BookChapter 1Subsection 1Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Donec sagittis
malesuada nisi. Aliquam orci eros, vestibulum eu, placerat et, pretium sed,
nisi. Proin consequat. Praesent faucibus sem id arcu hendrerit nonummy.
Aliquam blandit accumsan pede. Vivamus aliquet lacinia nunc. Praesent dapibus
orci eu magna. Cras nonummy, pede nec facilisis semper, sem nibh vestibulum
massa, sed ornare tortor elit non lectus. Nullam mauris turpis, luctus et,
vulputate vitae, commodo sit amet, purus. Fusce erat. Proin ullamcorper
imperdiet est. Morbi sit amet dui. Fusce bibendum auctor augue. Sed leo
sapien, vehicula ac, nonummy id, cursus at, nulla. Ut sed purus.Subsubsection 1Suspendisse sagittis metus nec leo. Suspendisse velit. Phasellus ipsum
dolor, porttitor ut1, varius id, scelerisque vel, ligula. Aliquam tempor sem
in pede tincidunt nonummy. Vestibulum et nulla. Nunc et dolor a risus
porttitor tem pus. Sed felis arcu, consectetuer non, imperdiet sollicitudin,
ullamcorper vitae, nulla. Vestibulum ante ipsum primis in faucibus.Subsection 2Duis eget libero aliquet quam ultrices malesuada. Donec molestie
dignissim nunc. Curabitur turpis. Suspendisse a nibh ut elit vulputate
ultrices. Etiam nulla erat, nonummy vel, fringilla at, scelerisque non, ante.
Suspendisse adipiscing rhoncus purus. Nulla in augue. Ut ac nisi eu nisi
cursus elementum. Pellentesque habitant morbi tristique senectus et netus et
malesuada fames ac turpis egestas. Donec et turpis. Donec nec mi. Mauris
malesuada congue sem. Maecenas et urna in nisi sagittis facilisis. Cras nibh.
Aliquam purus. Donec convallis congue libero. Nulla feugiat. Nulla massa
libero, consectetuer ac, aliquet ac, consequat eu, purus. Pellentesque
eleifend pretium augue.Subsection 3Integer auctor, nisi ut convallis imperdiet, ligula diam sollicitudin
dolor, porttitor mattis urna sapien at velit. Fusce vestibulum, neque nec
malesuada tempor, tortor nisi accumsan purus, quis faucibus metus elit ac
urna. Aliquam commodo velit vel ipsum. Donec blandit diam blandit eros.
Aliquam pretium fermentum neque. Sed nec tellus eu orci ullamcorper facilisis.
Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac
turpis egestas. Nulla sed leo. Class aptent taciti sociosqu ad litora torquent
per conubia nostra, per inceptos hymenaeos. Fusce suscipit. Sed sit amet diam
ac ante tincidunt ornare. Sed sodales vestibulum quam. Fusce accumsan. Ut ut
mi.Subsection 4Maecenas tincidunt lobortis nunc. Phasellus euismod diam sit amet felis.
Donec lorem metus, vulputate vitae, ornare vel, molestie sit amet, pede. In
erat velit, adipiscing sed, varius in, interdum cursus, enim. Quisque dolor
ante, tincidunt vel, congue eget, consectetuer id, nunc. Suspendisse
hendrerit. Proin egestas, massa eget egestas ullamcorper, nisl elit gravida
magna, vitae dignissim odio velit ut tortor. Fusce lobortis consequat nulla.
Vestibulum pretium justo at metus. Sed lorem velit, elementum eget,
pellentesque ac, ornare id, mi. Pellentesque vel ligula et erat dictum
commodo. Integer malesuada lacus nec metus. Aliquam id purus ac neque mattis
venenatis. Aenean lobortis accumsan massa. Donec dui ante, facilisis vel,
hendrerit ut, vehicula in, eros. Suspendisse potenti. Sed fringilla.
Suspendisse vel nibh. Sed sit amet lacus quis massa tincidunt elementum. Ut ut
augue vitae ligula dapibus aliquam.Subsection 5Fusce non eros non lectus venenatis bibendum. Nullam pharetra. Nunc
commodo pede et metus. Pellentesque habitant morbi tristique senectus et netus
et malesuada fames ac turpis egestas. Vestibulum imperdiet nisl nec nulla.
Morbi congue dictum pede. Aliquam ligula. In pede nulla, varius a, blandit ut,
pulvinar vitae, mauris. Suspendisse sit amet magna. Curabitur cursus placerat
justo. Vivamus imperdiet magna commodo mi. Vestibulum eget metus quis sem
sollicitudin consectetuer. Morbi metus augue, elementum rutrum, luctus quis,
porttitor a, est. Phasellus quis sapien et augue adipiscing fermentum. Sed
fermentum tristique dui. Vivamus aliquam, tortor at ultricies commodo, urna
ipsum fringilla neque, sit amet congue purus enim a justo.Section 1.10.32 of "de Finibus Bonorum et Malorum",
written by Cicero in 45 BCSed ut perspiciatis unde omnis iste natus error sit voluptatem
accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo
inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo.
Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit,
sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt.
Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur,
adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et
dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis
nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex
ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea
voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem
eum fugiat quo voluptas nulla pariatur?Chapter 21914 translation by H. RackhamBut I must explain to you how all this mistaken idea of denouncing
pleasure and praising pain was born and I will give you a complete account of
the system, and expound the actual teachings of the great explorer of the
truth, the master-builder of human happiness. No one rejects, dislikes, or
avoids pleasure itself, because it is pleasure, but because those who do not
know how to pursue pleasure rationally encounter consequences that are
extremely painful. Nor again is there anyone who loves or pursues or desires
to obtain pain of itself, because it is pain, but because occasionally
circumstances occur in which toil and pain can procure him some great
pleasure. To take a trivial example, which of us ever undertakes laborious
physical exercise, except to obtain some advantage from it? But who has any
right to find fault with a man who chooses to enjoy a pleasure that has no
annoying consequences, or one who avoids a pain that produces no resultant
pleasure?Section 1.10.33 of "de Finibus Bonorum et Malorum",
written by Cicero in 45 BCAt vero eos et accusamus et iusto odio dignissimos ducimus qui
blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas
molestias excepturi sint occaecati cupiditate non provident, similique sunt in
culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et
harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum
soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime
placeat facere possimus, omnis voluptas assumenda est, omnis dolor
repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum
necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae
non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut
reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus
asperiores repellat.
doxia-1.1.4/doxia-book/src/test/java/ 0000755 0001750 0001750 00000000000 11632765560 017315 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765560 020104 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765560 021325 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765560 022433 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765560 023537 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/ 0000755 0001750 0001750 00000000000 11632765560 024471 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/ 0000755 0001750 0001750 00000000000 11632765560 026314 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/indexer/ 0000755 0001750 0001750 00000000000 11632765560 027752 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000147 00000000000 011567 L ustar root root doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/indexer/BookIndexerTest.java doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/indexer/BookIndexerTest.ja0000644 0001750 0001750 00000011231 10767707462 033342 0 ustar twerner twerner package org.apache.maven.doxia.book.services.indexer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.services.io.BookIo;
import org.apache.maven.doxia.index.IndexEntry;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
/**
* @author Trygve Laugstøl
* @version $Id: BookIndexerTest.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public class BookIndexerTest
extends PlexusTestCase
{
public void testBasic()
throws Exception
{
BookIo io = (BookIo) lookup( BookIo.ROLE );
BookIndexer indexer = (BookIndexer) lookup( BookIndexer.ROLE );
BookModel book = io.readBook( getTestFile( "src/test/resources/book-1.xml" ) );
BookContext context = new BookContext();
io.loadFiles( context, FileUtils.getFiles( getTestFile( "src/test/resources/book-1" ), "*.apt", "" ) );
indexer.indexBook( book, context );
IndexEntry root = context.getIndex();
assertNotNull( root );
assertEquals( 2, root.getChildEntries().size() );
IndexEntry c1 = assertIndexEntry( root, 0, "Chapter 1", "chapter-1", 2 );
// -----------------------------------------------------------------------
// Section 1
// -----------------------------------------------------------------------
IndexEntry s1 = assertIndexEntry( c1, 0, "Section 1", "section-1", 5 );
IndexEntry ss1 = assertIndexEntry( s1, 0, "Subsection 1", "Subsection_1", 1 );
assertIndexEntry( ss1, 0, "Subsubsection 1", "Subsubsection_1", 0 );
assertIndexEntry( s1, 1, "Subsection 2", "Subsection_2", 0 );
assertIndexEntry( s1, 2, "Subsection 3", "Subsection_3", 0 );
assertIndexEntry( s1, 3, "Subsection 4", "Subsection_4", 0 );
// -----------------------------------------------------------------------
// Section 2
// -----------------------------------------------------------------------
IndexEntry s2 = assertIndexEntry( c1, 1, "Section 2", "section-2", 1 );
assertIndexEntry( s2, 0, "Section 1.10.32 of \"de Finibus Bonorum et Malorum\", written by Cicero in 45 BC",
"Section_1.10.32_of_\"de_Finibus_Bonorum_et_Malorum\",_written_by_Cicero_in_45_BC", 0 );
// -----------------------------------------------------------------------
// Chapter 2
// -----------------------------------------------------------------------
IndexEntry c2 = assertIndexEntry( root, 1, "Chapter 2", "chapter-2", 2 );
IndexEntry s3 = assertIndexEntry( c2, 0, "Section 3", "section-3", 1 );
assertIndexEntry( s3, 0, "1914 translation by H. Rackham", "1914_translation_by_H._Rackham", 0 );
IndexEntry s4 = assertIndexEntry( c2, 1, "Section 4", "section-4", 1 );
assertIndexEntry( s4, 0, "Section 1.10.33 of \"de Finibus Bonorum et Malorum\", written by Cicero in 45 BC",
"Section_1.10.33_of_\"de_Finibus_Bonorum_et_Malorum\",_written_by_Cicero_in_45_BC", 0 );
}
private IndexEntry assertIndexEntry( IndexEntry parent, int childIndex, String title, String id, int childCount )
{
assertTrue( "parent: " + parent.getId() + ", " +
"required count: " + childCount + ", " +
"actual count: " + parent.getChildEntries().size(),
childIndex < parent.getChildEntries().size() );
IndexEntry indexEntry = (IndexEntry) parent.getChildEntries().get( childIndex );
assertEquals( title, indexEntry.getTitle() );
assertEquals( HtmlTools.encodeId( id ), indexEntry.getId() );
assertEquals( childCount, indexEntry.getChildEntries().size() );
return indexEntry;
}
}
doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/renderer/ 0000755 0001750 0001750 00000000000 11632765560 030122 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/renderer/docbook/ 0000755 0001750 0001750 00000000000 11632765560 031542 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000164 00000000000 011566 L ustar root root doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSinkTest.java doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBo0000644 0001750 0001750 00000032645 11214446323 033265 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.docbook;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import java.util.Locale;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.SimpleAttributeSet;
import org.apache.maven.doxia.module.docbook.DocBookSink;
import org.apache.maven.doxia.sink.AbstractSinkTest;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkUtils;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.codehaus.plexus.util.FileUtils;
/**
* Test the book path of the DockBook sink
* @author Dave Syer
*/
public class DocBookBookSinkTest extends AbstractSinkTest
{
/** {@inheritDoc} */
protected boolean isXmlSink()
{
return true;
}
/** {@inheritDoc} */
protected String outputExtension()
{
return "docbook";
}
/** {@inheritDoc} */
protected Sink createSink( Writer writer )
{
return new DocBookBookSink( writer );
}
//
// DocBookBookSink specific
//
/**
* Checks that the sequence [bookTitle(), text( title ), bookTitle_()],
* invoked on the current sink, produces the same result as
* {@link #getBookTitleBlock getBookTitleBlock}( title ).
* NewLines are ignored.
*/
public void testBookTitle()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
String title = "Grodek";
sink.bookTitle();
sink.text( title );
sink.bookTitle_();
sink.flush();
String actual = getSinkContent();
String expected = getBookTitleBlock( title );
assertEquals( "Wrong book title!", expected, actual );
}
/**
* Checks that the sequence [bookAuthor(), text( author ), bookAuthor_()]
* , invoked on the current sink, produces the same result as
* {@link #getBookAuthorBlock getBookAuthorBlock}( author ).
* NewLines are ignored.
*/
public void testBookAuthor()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
String author = "Georg Trakl";
sink.bookAuthor();
sink.text( author );
sink.bookAuthor_();
sink.flush();
String actual = getSinkContent();
String expected = getBookAuthorBlock( author );
assertEquals( "Wrong book author!", expected, actual );
}
/**
* Checks that the sequence [bookDate(), text( date ), bookDate_()],
* invoked on the current sink, produces the same result as
* {@link #getBookDateBlock getBookDateBlock}( date ). NewLines are ignored.
*/
public void testBookDate()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
String date = "1914";
sink.bookDate();
sink.text( date );
sink.bookDate_();
sink.flush();
String actual = getSinkContent();
String expected = getBookDateBlock( date );
assertEquals( "Wrong book date!", expected, actual );
}
/**
* Checks that the sequence [bookHead(), bookHead_()],
* invoked on the current sink, produces the same result as
* {@link #getBookHeadBlock getBookHeadBlock()}. NewLines are ignored.
*/
public void testBookHead()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
//sink.bookHead();
sink.bookHead_();
sink.flush();
String actual = getSinkContent();
String expected = getBookHeadBlock();
assertEquals( "Wrong book head!", expected, actual );
}
/**
* Checks that the sequence [book(), book_()],
* invoked on the current sink, produces the same result as
* {@link #getBookBlock getBookBlock()}. NewLines are ignored.
*/
public void testBook()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
sink.book();
sink.book_();
sink.flush();
String actual = getSinkContent();
String expected = getBookBlock();
assertEquals( "Wrong book body!", expected, actual );
}
/**
* Checks that the sequence [chapterTitle(), text( title ),
* chapterTitle_()], invoked on the current sink, produces
* the same result as
* {@link #getChapterTitleBlock getChapterTitleBlock}( title ).
* NewLines are ignored.
*/
public void testChapterTitle()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
String title = "Title";
sink.chapterTitle();
sink.text( title );
sink.chapterTitle_();
sink.flush();
String actual = getSinkContent();
String expected = getChapterTitleBlock( title );
assertEquals( "Wrong chapterTitle!", expected, actual );
}
/**
* Checks that the sequence [chapter(), chapter_()],
* invoked on the current sink, produces the same result as
* {@link #getChapterBlock getChapterBlock}().
* NewLines are ignored.
*/
public void testChapter()
{
DocBookBookSink sink = (DocBookBookSink) getSink();
sink.chapter();
sink.chapter_();
sink.flush();
String actual = getSinkContent();
String expected = getChapterBlock();
assertEquals( "Wrong chapter block!", expected, actual );
}
/**
* Returns a title block generated by this sink.
* @param title The title to use.
* @return The result of invoking a title block on the current sink.
* @see #testBookTitle()
*/
protected String getBookTitleBlock( String title )
{
return "" + title + "";
}
/**
* Returns an author block generated by this sink.
* @param author The author to use.
* @return The result of invoking an author block on the current sink.
* @see #testBookAuthor()
*/
protected String getBookAuthorBlock( String author )
{
return "" + author + "";
}
/**
* Returns a date block generated by this sink.
* @param date The date to use.
* @return The result of invoking a date block on the current sink.
* @see #testBookDate()
*/
protected String getBookDateBlock( String date )
{
return "" + date + "";
}
/**
* Returns a head block generated by this sink.
* @return The result of invoking a head block on the current sink.
* @see #testBookHead()
*/
protected String getBookHeadBlock()
{
return "";
}
/**
* Returns a body block generated by this sink.
* @return The result of invoking a body block on the current sink.
* @see #testBook()
*/
protected String getBookBlock()
{
return "";
}
/**
* Returns a SectionTitle block generated by this sink.
* @param title The title to use.
* @return The result of invoking a SectionTitle block on the current sink.
* @see #testChapterTitle()
*/
protected String getChapterTitleBlock( String title )
{
return "" + title + "";
}
/**
* Returns a Section1 block generated by this sink.
* @param title The title to use.
* @return The result of invoking a Section1 block on the current sink.
* @see #testChapter()
*/
protected String getChapterBlock()
{
return "";
}
//
// from DocBookSink
//
/** {@inheritDoc} */
protected String getTitleBlock( String title )
{
return "";
}
/** {@inheritDoc} */
protected String getAuthorBlock( String author )
{
return "";
}
/** {@inheritDoc} */
protected String getDateBlock( String date )
{
return "" + date + "";
}
/** {@inheritDoc} */
protected String getHeadBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getBodyBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getSectionTitleBlock( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getSection1Block( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getSection2Block( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getSection3Block( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getSection4Block( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getSection5Block( String title )
{
return "" + title + "";
}
/** {@inheritDoc} */
protected String getListBlock( String item )
{
return "" + item + "";
}
/** {@inheritDoc} */
protected String getNumberedListBlock( String item )
{
return ""
+ item + "";
}
/** {@inheritDoc} */
protected String getDefinitionListBlock( String definum, String definition )
{
return "" + definum
+ "" + definition
+ "";
}
/** {@inheritDoc} */
protected String getFigureBlock( String source, String caption )
{
String format = FileUtils.extension( source ).toUpperCase( Locale.ENGLISH );
return ""
+ ""
+ "
" + caption + "
";
}
/** {@inheritDoc} */
protected String getTableBlock( String cell, String caption )
{
// Using the same set ordering than the JVM
MutableAttributeSet att = new SimpleAttributeSet();
att.addAttribute( "frame", "none" );
att.addAttribute( "rowsep", "0" );
att.addAttribute( "colsep", "0" );
return "" + caption
+ ""
+ cell + "";
}
/** {@inheritDoc} */
protected String getParagraphBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getVerbatimBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getHorizontalRuleBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getPageBreakBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getAnchorBlock( String anchor )
{
return "" + anchor + "";
}
/** {@inheritDoc} */
protected String getLinkBlock( String link, String text )
{
String linkend = DoxiaUtils.isInternalLink( link ) ? link.substring( 1 ) : link;
return "" + text + "";
}
/** {@inheritDoc} */
protected String getItalicBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getBoldBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getMonospacedBlock( String text )
{
return "" + text + "";
}
/** {@inheritDoc} */
protected String getLineBreakBlock()
{
return "";
}
/** {@inheritDoc} */
protected String getNonBreakingSpaceBlock()
{
return " ";
}
/** {@inheritDoc} */
protected String getTextBlock( String text )
{
// TODO: retreive those from the sink
return "~,_=,_-,_+,_*,_[,_],_<,_>,_{,_},_\\";
}
/** {@inheritDoc} */
protected String getRawTextBlock( String text )
{
// TODO
return "";
}
/** {@inheritDoc} */
protected String getCommentBlock( String text )
{
return "";
}
}
doxia-1.1.4/doxia-book/src/test/java/org/apache/maven/doxia/book/BookRendererTest.java 0000644 0001750 0001750 00000005546 11100621011 030533 0 ustar twerner twerner package org.apache.maven.doxia.book;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.StringUtils;
import org.apache.maven.doxia.book.model.BookModel;
import java.io.File;
import java.util.List;
/**
* @author Trygve Laugstøl
* @version $Id: BookRendererTest.java 707844 2008-10-25 13:41:29Z vsiveton $
*/
public class BookRendererTest
extends PlexusTestCase
{
public void testBasic()
throws Exception
{
BookDoxia doxia = (BookDoxia) lookup( BookDoxia.ROLE );
File book1 = getTestFile( "src/test/resources/book-1.xml" );
List files = FileUtils.getFiles( getTestFile( "src/test/resources/book-1" ), "**/*.apt, **/*.xml", "" );
BookModel book = doxia.loadBook( book1 );
doxia.renderBook( book, "pdf", files, getTestFile( "target/test-output/itext" ) );
doxia.renderBook( book, "xhtml", files, getTestFile( "target/test-output/xhtml" ) );
doxia.renderBook( book, "xdoc", files, getTestFile( "target/test-output/xdoc" ) );
doxia.renderBook( book, "latex", files, getTestFile( "target/test-output/latex" ) );
doxia.renderBook( book, "doc-book", files, getTestFile( "target/test-output/doc-book" ) );
doxia.renderBook( book, "rtf", files, getTestFile( "target/test-output/rtf" ) );
assertCorrectDocbook();
}
/**
* Regression test for the docbook output.
*/
private void assertCorrectDocbook()
throws Exception
{
String expected =
FileUtils.fileRead( getTestFile( "src/test/resources/expected/doc-book/plexus-user-guide.xml" ) );
expected = StringUtils.deleteWhitespace( expected );
String actual =
FileUtils.fileRead( getTestFile( "target/test-output/doc-book/plexus-user-guide.xml" ) );
actual = StringUtils.deleteWhitespace( actual );
assertEquals( "Wrong docbook output!",
StringUtils.replace( expected, "\r", "" ), StringUtils.replace( actual, "\r", "" ) );
}
}
doxia-1.1.4/doxia-book/src/site/ 0000755 0001750 0001750 00000000000 11632765560 016361 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/site/apt/ 0000755 0001750 0001750 00000000000 11632765560 017145 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/site/apt/index.apt 0000644 0001750 0001750 00000001333 10670231421 020743 0 ustar twerner twerner -----
Writing Books in Doxia
-----
Lukas Theussl
-----
Introduction
Doxia allows you to write books like user manuals and guides in any format supported by Doxia. Combined with the
Doxia Book Maven you are able to include the manuals directly in your generated site with links to the off-line
friendly formats like XDoc, PDF, RTF and LaTeX.
* How It Works
The only thing you need in addition to the content files itself is a simple book descriptor which is used to specify
the ordering of the sections and the names for the chapters.
See {{{./book.html}The Book Descriptor Reference}} for a reference to the descriptor. A sample is given on the
main Doxia {{{http://maven.apache.org/doxia/book/index.html}site}}.
doxia-1.1.4/doxia-book/src/site/apt/using-book-xsd.apt 0000644 0001750 0001750 00000002645 11140054106 022510 0 ustar twerner twerner -----
Using Schema Book 1.0
-----
Vincent Siveton
------
2009-01-28
------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Using Schema Book 1.0
The Decoration XSD is located {{{http://maven.apache.org/xsd/book-1.0.0.xsd}here}}.
Your favorite IDE probably supports XSD schema's for .xml files. You need to specify the following:
+-----+
...
+-----+
doxia-1.1.4/doxia-book/src/site/apt/usage.apt 0000644 0001750 0001750 00000002155 10670231421 020743 0 ustar twerner twerner -----
Usage
-----
Lukas Theussl
-----
Usage
Below is a simple example to illustrate how to use it.
+------------------------------------------------------
BookDoxia doxia = (BookDoxia) lookup( BookDoxia.ROLE );
// load the book descriptor
File book1 = new File( "book-1.xml" );
BookModel book = doxia.loadBook( book1 );
// files to include
List files = FileUtils.getFiles( new File( "src/resources/book/" ), "**/*.apt, **/*.xml", "" );
// render books in different formats
doxia.renderBook( book, "pdf", files, new File( "target/itext/" ) );
doxia.renderBook( book, "xhtml", files, new File( "target/xhtml/" ) );
doxia.renderBook( book, "xdoc", files, new File( "target/xdoc/" ) );
doxia.renderBook( book, "latex", files, new File( "target/latex/" ) );
doxia.renderBook( book, "doc-book", files, new File( "target/doc-book/" ) );
doxia.renderBook( book, "rtf", files, new File( "target/rtf/" ) );
+------------------------------------------------------
See the {{{./apidocs/index.html}Javadocs}} for more details.
doxia-1.1.4/doxia-book/src/site/site.xml 0000644 0001750 0001750 00000003112 11140054106 020021 0 ustar twerner twerner
doxia-1.1.4/doxia-book/src/main/ 0000755 0001750 0001750 00000000000 11632765560 016341 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/modello/ 0000755 0001750 0001750 00000000000 11632765560 017774 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/modello/book.mdo 0000644 0001750 0001750 00000042343 11215146576 021432 0 ustar twerner twerner
bookBookModel
This descriptor specifies the metadatas and the content for a book.
A book is defined by a collection of chapters, a chapter by a
collection of sections, a section by a file.
]]>
packageorg.apache.maven.doxia.book.modelBookModel
Describes the book layout and packaging.
1.0.0id1.0.0Stringtrue
Specifies the id of this book. This is a symbolic name for a
particular book from this project.
title1.0.0String
Specifies the title of this book.
author1.0.0String
Specifies the author of this book.
date1.0.0String
Specifies the date of this book.
chapters1.0.0
Specifies a collection of chapters.
Chapter*Chapter1.0.0id1.0.0Stringtrue
Specifies the id of this chapter. This is a symbolic name for a
particular chapter.
title1.0.0String
Specifies the title of this chapter.
sections1.0.0
Specifies a collection of sections.
Section*Section1.0.0id1.0.0Stringtrue
Specifies the id of this section. This is a symbolic name for a
particular section.
title1.0.0String
Specifies the title of this section.
file1.0.0String
Specifies the file of this section.
doxia-1.1.4/doxia-book/src/main/resources/ 0000755 0001750 0001750 00000000000 11632765560 020353 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/resources/book-renderer_en.properties 0000644 0001750 0001750 00000002275 11136250225 025701 0 ustar twerner twerner # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
# NOTE:
# This bundle is intentionally empty because English strings are provided by the base bundle via the parent chain. It
# must be provided nevertheless such that a request for locale "en" will not errorneously pick up the bundle for the
# JVM's default locale (which need not be "en"). See the method javadoc about
# ResourceBundle.getBundle(String, Locale, ClassLoader)
# for a full description of the lookup strategy.
doxia-1.1.4/doxia-book/src/main/resources/book-renderer_fr.properties 0000644 0001750 0001750 00000001520 11142023576 025702 0 ustar twerner twerner # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
toc=Table des matičres
previous=Précédent
up=Haut
next=Suivant
doxia-1.1.4/doxia-book/src/main/resources/book-renderer.properties 0000644 0001750 0001750 00000001510 10553273463 025221 0 ustar twerner twerner # Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
toc=Table Of Content
previous=Previous
up=Up
next=Next
doxia-1.1.4/doxia-book/src/main/java/ 0000755 0001750 0001750 00000000000 11632765560 017262 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765560 020051 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765560 021272 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765560 022400 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765560 023504 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/ 0000755 0001750 0001750 00000000000 11632765560 024436 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000145 00000000000 011565 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/InvalidBookDescriptorException.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/InvalidBookDescriptorException.java0000644 0001750 0001750 00000003740 11175620077 033417 0 ustar twerner twerner package org.apache.maven.doxia.book;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.services.validation.ValidationResult;
/**
* Indicates that the book descriptor file could not be parsed correctly.
*
* @author Trygve Laugstøl
* @version $Id: InvalidBookDescriptorException.java 769433 2009-04-28 15:26:55Z ltheussl $
*/
public class InvalidBookDescriptorException
extends BookDoxiaException
{
/** serialVersionUID */
private static final long serialVersionUID = -5706648416915909753L;
/** ValidationResult. */
private ValidationResult validationResult;
/**
* Construct a new InvalidBookDescriptorException and stores the given ValidationResult.
*
* @param validationResult The ValidationResult to store.
*/
public InvalidBookDescriptorException( ValidationResult validationResult )
{
super( "Invalid book descriptor." );
this.validationResult = validationResult;
}
/**
* Return the ValidationResult.
*
* @return the ValidationResult associated with this Exception.
*/
public ValidationResult getValidationResult()
{
return validationResult;
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/ 0000755 0001750 0001750 00000000000 11632765560 026261 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/ 0000755 0001750 0001750 00000000000 11632765560 027717 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/DefaultBookIndexer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/DefaultBookIndexer0000644 0001750 0001750 00000012247 10767707462 033373 0 ustar twerner twerner package org.apache.maven.doxia.book.services.indexer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.util.Iterator;
import org.apache.maven.doxia.Doxia;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.context.BookIndex;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.index.IndexEntry;
import org.apache.maven.doxia.index.IndexingSink;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.codehaus.plexus.logging.AbstractLogEnabled;
/**
* Default implementation of BookIndexer.
*
* @plexus.component
*
* @author Trygve Laugstøl
* @version $Id: DefaultBookIndexer.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public class DefaultBookIndexer
extends AbstractLogEnabled
implements BookIndexer
{
/**
* @plexus.requirement
*/
private Doxia doxia;
// ----------------------------------------------------------------------
// BookIndexer Implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void indexBook( BookModel book, BookContext bookContext )
throws BookDoxiaException
{
BookIndex index = new BookIndex();
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
indexChapter( bookContext, index, chapter );
}
bookContext.setIndex( index );
}
// ----------------------------------------------------------------------
// Private
// ----------------------------------------------------------------------
/**
* Index a chapter.
*
* @param context the BookContext.
* @param bookEntry the IndexEntry.
* @param chapter the Chapter to index.
* @throws BookDoxiaException if the chapter cannot be indexed.
*/
private void indexChapter( BookContext context, IndexEntry bookEntry, Chapter chapter )
throws BookDoxiaException
{
IndexEntry chapterEntry = new IndexEntry( bookEntry, chapter.getId( ) );
chapterEntry.setTitle( chapter.getTitle() );
for ( Iterator it = chapter.getSections().iterator(); it.hasNext(); )
{
Section section = (Section) it.next();
indexSection( context, chapterEntry, section );
}
}
/**
* Index a section.
*
* @param bookContext the BookContext.
* @param chapterEntry the IndexEntry.
* @param section the Section to index.
* @throws BookDoxiaException if the section cannot be indexed.
*/
private void indexSection( BookContext bookContext, IndexEntry chapterEntry, Section section )
throws BookDoxiaException
{
BookContext.BookFile bookFile = (BookContext.BookFile) bookContext.getFiles().get( section.getId() );
if ( bookFile == null )
{
throw new BookDoxiaException( "No document that matches section with id="
+ section.getId() + "." );
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
IndexEntry sectionEntry = new IndexEntry( chapterEntry, section.getId() );
IndexingSink sink = new IndexingSink( sectionEntry );
try
{
doxia.parse( new FileReader( bookFile.getFile() ), bookFile.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
throw new BookDoxiaException( "Parser not found: "
+ bookFile.getParserId() + ".", e );
}
catch ( ParseException e )
{
throw new BookDoxiaException( "Error while parsing document: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
catch ( FileNotFoundException e )
{
throw new BookDoxiaException( "Could not find document: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
sectionEntry.setTitle( sink.getTitle() );
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/indexer/BookIndexer.java 0000644 0001750 0001750 00000003140 11150511552 032752 0 ustar twerner twerner package org.apache.maven.doxia.book.services.indexer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.BookDoxiaException;
/**
* Index a book.
*
* @author Trygve Laugstøl
* @version $Id: BookIndexer.java 746976 2009-02-23 12:15:38Z vsiveton $
*/
public interface BookIndexer
{
/** The plexus lookup role. */
String ROLE = BookIndexer.class.getName();
/**
* Index a book.
*
* @param book the book to index.
* @param bookContext the BookContext.
* @throws org.apache.maven.doxia.book.BookDoxiaException if the book cannot be indexed.
*/
void indexBook( BookModel book, BookContext bookContext )
throws BookDoxiaException;
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/ 0000755 0001750 0001750 00000000000 11632765560 030067 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/LatexBookRenderer0000644 0001750 0001750 00000020243 11451074657 033371 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.services.renderer.latex.LatexBookSink;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.Doxia;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.WriterFactory;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.io.PrintWriter;
import java.io.FileNotFoundException;
import java.io.Reader;
import java.io.Writer;
import java.util.Iterator;
import java.util.Map;
import java.util.HashMap;
/**
*
LatexBookRenderer class.
*
* @plexus.component role-hint="latex"
* @author Trygve Laugstøl
* @version $Id: LatexBookRenderer.java 1003021 2010-09-30 11:51:11Z ltheussl $
*/
public class LatexBookRenderer
implements BookRenderer
{
/**
* @plexus.requirement
*/
private Doxia doxia;
// ----------------------------------------------------------------------
// BookRenderer Implementatino
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void renderBook( BookContext context )
throws BookDoxiaException
{
BookModel book = context.getBook();
if ( !context.getOutputDirectory().exists() )
{
if ( !context.getOutputDirectory().mkdirs() )
{
throw new BookDoxiaException(
"Could not make directory: " + context.getOutputDirectory().getAbsolutePath() + "." );
}
}
File bookFile = new File( context.getOutputDirectory(), book.getId() + ".tex" );
FileWriter fileWriter = null;
try
{
fileWriter = new FileWriter( bookFile );
PrintWriter writer = new PrintWriter( fileWriter );
writeBook( book, context, writer );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while opening file.", e );
}
finally
{
IOUtil.close( fileWriter );
}
}
// ----------------------------------------------------------------------
// Private
// ----------------------------------------------------------------------
/** SectionInfo: id and title. */
static class SectionInfo
{
/** id. */
String id;
/** title. */
String title;
}
/**
* Write a book.
*
* @param book the BookModel to write.
* @param context the BookContext.
* @param writer the writer to use.
* @throws IOException if any.
* @throws BookDoxiaException if the section cannot be written.
*/
private void writeBook( BookModel book, BookContext context, PrintWriter writer )
throws IOException, BookDoxiaException
{
// ----------------------------------------------------------------------
// Process all the section documents and collect their names
// ----------------------------------------------------------------------
Map sectionInfos = new HashMap();
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
for ( Iterator j = chapter.getSections().iterator(); j.hasNext(); )
{
Section section = (Section) j.next();
SectionInfo info = writeSection( section, context );
sectionInfos.put( info.id, info );
}
}
// ----------------------------------------------------------------------
// Write the main .tex file
// ----------------------------------------------------------------------
writer.println( "\\documentclass{book}" );
writer.println( "\\title{" + book.getTitle() + "}" );
if ( StringUtils.isNotEmpty( book.getAuthor() ) )
{
writer.println( "\\author{" + book.getAuthor() + "}" );
}
if ( StringUtils.isNotEmpty( book.getDate() ) )
{
writer.println( "\\date{" + book.getDate() + "}" );
}
LatexBookSink sink = new LatexBookSink( writer );
sink.defaultBookPreamble();
writer.println( "\\begin{document}" );
writer.println( "\\maketitle" );
writer.println( "\\tableofcontents" );
// writer.println( "\\listoffigures" );
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
writer.println( "\\chapter{" + chapter.getTitle() + "}" );
for ( Iterator j = chapter.getSections().iterator(); j.hasNext(); )
{
Section section = (Section) j.next();
SectionInfo info = (SectionInfo) sectionInfos.get( section.getId() );
writer.println( "\\input{" + info.id + "}" );
}
}
writer.println( "\\end{document}" );
}
/**
* Write a section.
*
* @param section the Section to write.
* @param context the BookContext.
* @return SectionInfo
* @throws IOException if any.
* @throws BookDoxiaException if the section cannot be written.
*/
private SectionInfo writeSection( Section section, BookContext context )
throws IOException, BookDoxiaException
{
File file = new File( context.getOutputDirectory(), ( section.getId() + ".tex" ) );
Writer writer = WriterFactory.newWriter( file, context.getOutputEncoding() );
LatexBookSink sink = new LatexBookSink( writer );
BookContext.BookFile bookFile = (BookContext.BookFile) context.getFiles().get( section.getId() );
if ( bookFile == null )
{
throw new BookDoxiaException( "No document that matches section with id="
+ section.getId() + "." );
}
Reader reader = null;
try
{
reader = ReaderFactory.newReader( bookFile.getFile(), context.getInputEncoding() );
doxia.parse( reader, bookFile.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
throw new BookDoxiaException( "Parser not found: "
+ bookFile.getParserId() + ".", e );
}
catch ( ParseException e )
{
throw new BookDoxiaException( "Error while parsing document: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
catch ( FileNotFoundException e )
{
throw new BookDoxiaException( "Could not find document: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
finally
{
sink.flush();
sink.close();
IOUtil.close( reader );
IOUtil.close( writer );
}
SectionInfo info = new SectionInfo();
info.id = section.getId();
info.title = sink.getTitle();
return info;
}
}
././@LongLink 0000000 0000000 0000000 00000000152 00000000000 011563 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XHtmlBookRenderer0000644 0001750 0001750 00000015423 11215145553 033344 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.Doxia;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.book.services.renderer.xhtml.XhtmlBookSink;
import org.apache.maven.doxia.sink.render.RenderingContext;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.parser.ParseException;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import java.io.File;
import java.io.FileNotFoundException;
import java.io.FileWriter;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.util.Iterator;
/**
*
XHtmlBookRenderer class.
*
* @plexus.component role-hint="xhtml"
* @author Trygve Laugstøl
* @version $Id: XHtmlBookRenderer.java 784534 2009-06-14 10:05:31Z vsiveton $
*/
public class XHtmlBookRenderer
extends AbstractLogEnabled
implements BookRenderer
{
/**
* @plexus.requirement
*/
private Doxia doxia;
// ----------------------------------------------------------------------
// BookRenderer Implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void renderBook( BookContext context )
throws BookDoxiaException
{
BookModel book = context.getBook();
if ( !context.getOutputDirectory().exists() )
{
if ( !context.getOutputDirectory().mkdirs() )
{
throw new BookDoxiaException( "Could not make directory: "
+ context.getOutputDirectory().getAbsolutePath() + "." );
}
}
File bookFile = new File( context.getOutputDirectory(), book.getId() + ".xhtml" );
Writer fileWriter;
try
{
fileWriter = new FileWriter( bookFile );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while opening file.", e );
}
XhtmlBookSink sink = new XhtmlBookSink( fileWriter,
new RenderingContext( context.getOutputDirectory(), bookFile.getAbsolutePath() ) );
try
{
sink.bookHead();
sink.bookTitle();
sink.text( context.getBook().getTitle() );
sink.bookTitle_();
sink.bookAuthor();
sink.text( context.getBook().getAuthor() );
sink.bookAuthor_();
sink.bookDate();
sink.text( context.getBook().getDate() );
sink.bookDate_();
sink.bookHead_();
sink.bookBody();
int chapterNumber = 1;
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
sink.sectionTitle();
sink.text( Integer.toString( chapterNumber ) + ". " + chapter.getTitle() );
sink.sectionTitle_();
renderChapter( sink, chapter, context );
chapterNumber++;
}
sink.bookBody_();
}
finally
{
sink.flush();
sink.close();
IOUtil.close( fileWriter );
}
}
// ----------------------------------------------------------------------
// Private
// ----------------------------------------------------------------------
/**
* Write a chapter.
*
* @param sink the XhtmlBookSink.
* @param chapter the Chapter.
* @param context the BookContext.
* @throws BookDoxiaException if the chapter cannot be written.
*/
private void renderChapter( XhtmlBookSink sink, Chapter chapter, BookContext context )
throws BookDoxiaException
{
for ( Iterator it = chapter.getSections().iterator(); it.hasNext(); )
{
Section section = (Section) it.next();
renderSection( sink, section, context );
}
}
/**
* Write a section.
*
* @param sink the XhtmlBookSink.
* @param section the Section.
* @param context the BookContext.
* @throws BookDoxiaException if the section cannot be written.
*/
private void renderSection( XhtmlBookSink sink, Section section, BookContext context )
throws BookDoxiaException
{
sink.section2();
BookContext.BookFile bookFile = (BookContext.BookFile) context.getFiles().get( section.getId() );
if ( bookFile == null )
{
throw new BookDoxiaException( "No document that matches section with id=" + section.getId() + "." );
}
Reader reader = null;
try
{
reader = ReaderFactory.newReader( bookFile.getFile(), context.getInputEncoding() );
doxia.parse( reader, bookFile.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
throw new BookDoxiaException( "Parser not found: "
+ bookFile.getParserId() + ".", e );
}
catch ( ParseException e )
{
throw new BookDoxiaException( "Error while parsing document: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
catch ( FileNotFoundException e )
{
throw new BookDoxiaException( "Could not find document: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering book: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
finally
{
IOUtil.close( reader );
}
sink.section2_();
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/ 0000755 0001750 0001750 00000000000 11632765560 031507 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000160 00000000000 011562 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/docbook/DocBookBo0000644 0001750 0001750 00000013434 11245330573 033230 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.docbook;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.module.docbook.DocBookSink;
/**
* An Docbook Sink that doesn't write out head or body elements for every section of a book, and has some convenience
* methods relating to the construction of a Doxia Book.
*
* @author Dave Syer
* @version $Id: DocBookBookSink.java 808201 2009-08-26 22:04:43Z vsiveton $
* @since 1.1
*/
public class DocBookBookSink
extends DocBookSink
{
/** Indicates if we're inside a head. */
private boolean hasHead = false;
/**
* Construct a new DocBookSink.
*
* @param out the writer for the sink.
*/
public DocBookBookSink( Writer out )
{
super( out );
setSystemId( "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" );
setPublicId( "-//OASIS//DTD DocBook V4.4//EN" );
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*
* Does nothing because we don't want the header from each document to crop up in the middle of a book.
*/
public void head()
{
// noop
}
/**
* {@inheritDoc}
*
* Does nothing because we don't want the header from each document to crop up in the middle of a book.
*/
public void head_()
{
// noop
}
/**
* {@inheritDoc}
*
* Marks the skip flag to true so that this element's text is not emitted by the base class.
*/
public void title()
{
setSkip( true );
}
/**
* {@inheritDoc}
*
* Marks the skip flag to false so that rendering can resume.
*/
public void title_()
{
setSkip( false );
}
/**
* {@inheritDoc}
*
* Marks the skip flag to true so that this element's text is not emitted by the base class.
*/
public void author()
{
setSkip( true );
}
/**
* {@inheritDoc}
*
* Marks the skip flag to false so that rendering can resume.
*/
public void author_()
{
setSkip( false );
}
/**
* {@inheritDoc}
*
* Does nothing because we don't want the header from each document to crop up in the middle of a book.
*/
public void body()
{
// noop
}
/**
* {@inheritDoc}
*
* Does nothing because we don't want the header from each document to crop up in the middle of a book.
*/
public void body_()
{
// noop
}
/**
* Emit the start tag for the book.
*
* @see org.apache.maven.doxia.module.docbook.DocbookMarkup#BOOK_TAG
*/
public void book()
{
init();
MutableAttributeSet att = writeXmlHeader( "book" );
writeStartTag( BOOK_TAG, att );
}
/**
* Emit the end tag for the book.
*
* @see org.apache.maven.doxia.module.docbook.DocbookMarkup#BOOK_TAG
*/
public void book_()
{
writeEndTag( BOOK_TAG );
flush();
}
/** If no header matter has yet been encountered emit the book info start tag. */
private void bookHead()
{
if ( !hasHead )
{
writeStartTag( BOOKINFO_TAG );
hasHead = true;
}
}
/**
* If some header matter has been encountered emit the book info end tag.
*/
public void bookHead_()
{
if ( hasHead )
{
writeEndTag( BOOKINFO_TAG );
hasHead = false;
}
}
/**
* Emit the title start tag for the whole book.
*/
public void bookTitle()
{
bookHead();
writeStartTag( Tag.TITLE );
}
/**
* Emit the title end tag for the whole book.
*/
public void bookTitle_()
{
super.title_();
}
/**
* Emit the author start tag for the whole book.
*/
public void bookAuthor()
{
bookHead();
super.author();
}
/**
* Emit the author end tag for the whole book.
*/
public void bookAuthor_()
{
super.author_();
}
/**
* Emit the date start tag for the whole book.
*/
public void bookDate()
{
bookHead();
super.date();
}
/**
* Emit the date end tag for the whole book.
*/
public void bookDate_()
{
super.date_();
}
/**
* Emit the chapter start tag.
*/
public void chapter()
{
writeStartTag( CHAPTER_TAG );
}
/**
* Emit the chapter end tag.
*/
public void chapter_()
{
writeEndTag( CHAPTER_TAG );
}
/**
* Emit the chapter title start tag.
*/
public void chapterTitle()
{
writeStartTag( Tag.TITLE );
}
/**
* Emit the chapter title end tag.
*/
public void chapterTitle_()
{
writeEndTag( Tag.TITLE );
}
}
././@LongLink 0000000 0000000 0000000 00000000145 00000000000 011565 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/BookRenderer.java0000644 0001750 0001750 00000002766 11150511552 033307 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.BookDoxiaException;
/**
* Render a book.
*
* @author Trygve Laugstøl
* @version $Id: BookRenderer.java 746976 2009-02-23 12:15:38Z vsiveton $
*/
public interface BookRenderer
{
/** The plexus lookup role. */
String ROLE = BookRenderer.class.getName();
/**
* Render a book.
*
* @param context the BookContext.
* @throws org.apache.maven.doxia.book.BookDoxiaException if the book cannot be rendered.
*/
void renderBook( BookContext context )
throws BookDoxiaException;
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/ 0000755 0001750 0001750 00000000000 11632765560 031024 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000157 00000000000 011570 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/IndexXdocBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/IndexXdocBoo0000644 0001750 0001750 00000005072 11212653116 033263 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import java.util.Locale;
import org.apache.maven.doxia.index.IndexEntry;
import org.codehaus.plexus.i18n.I18N;
/**
* A XdocSink implementation for index book.
*
* @author Trygve Laugstøl
* @author Vincent Siveton
* @version $Id: IndexXdocBookSink.java 782330 2009-06-07 05:55:26Z ltheussl $
*/
public class IndexXdocBookSink
extends AbstractXdocBookSink
{
/** the first IndexEntry. */
private final IndexEntry firstEntry;
/**
* Default constructor.
*
* @param out the Writer.
* @param firstEntry the first IndexEntry.
* @param i18n I18N.
* @param locale wanted locale.
*/
public IndexXdocBookSink( Writer out, IndexEntry firstEntry, I18N i18n, Locale locale )
{
super( out, i18n, locale );
this.firstEntry = firstEntry;
}
/** {@inheritDoc} */
protected void navigationPanel()
{
write( "" );
write( "
" );
write( "
" );
// -----------------------------------------------------------------------
// Next
// -----------------------------------------------------------------------
if ( firstEntry != null )
{
write( "
" );
write( "" );
}
}
././@LongLink 0000000 0000000 0000000 00000000162 00000000000 011564 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/AbstractXdocBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/AbstractXdoc0000644 0001750 0001750 00000006216 11245330573 033325 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import java.util.Locale;
import org.apache.maven.doxia.module.xdoc.XdocSink;
import org.codehaus.plexus.i18n.I18N;
import org.codehaus.plexus.util.StringUtils;
/**
* Abstract XdocSink implementation for book.
*
* @author Trygve Laugstøl
* @author Vincent Siveton
* @version $Id: AbstractXdocBookSink.java 808201 2009-08-26 22:04:43Z vsiveton $
*/
public abstract class AbstractXdocBookSink
extends XdocSink
{
/** I18N for localized messages. */
private final I18N i18n;
/** The wanted locale */
private final Locale locale;
/**
* Default constructor.
*
* @param out a Writer.
* @param i18n I18N.
* @param locale the wanted locale.
*/
public AbstractXdocBookSink( Writer out, I18N i18n, Locale locale )
{
super( out );
this.i18n = i18n;
this.locale = locale;
}
/** {@inheritDoc} */
public void date_()
{
// nop
}
/** {@inheritDoc} */
public void body()
{
writeStartTag( BODY );
write( "" );
navigationPanel();
horizontalRule();
write( "" );
}
/** {@inheritDoc} */
public void body_()
{
write( "" );
horizontalRule();
navigationPanel();
write( "" );
writeEndTag( BODY );
writeEndTag( DOCUMENT_TAG );
flush();
close();
init();
}
// -----------------------------------------------------------------------
// Protected
// -----------------------------------------------------------------------
/**
* Gets a trimmed String for the given key from the resource bundle defined by Plexus.
*
* @param key the key for the desired string
* @return the string for the given key
*/
protected String getString( String key )
{
if ( StringUtils.isEmpty( key ) )
{
throw new IllegalArgumentException( "The key cannot be empty" );
}
return i18n.getString( "book-renderer", locale, key ).trim();
}
/**
* Add a navigation panel.
*/
protected abstract void navigationPanel();
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/ChapterXdocBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/ChapterXdocB0000644 0001750 0001750 00000010424 11212653116 033241 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import java.util.Locale;
import org.apache.maven.doxia.index.IndexEntry;
import org.codehaus.plexus.i18n.I18N;
/**
* A XdocSink implementation for chapter in a book.
*
* @author Vincent Siveton
* @version $Id: ChapterXdocBookSink.java 782330 2009-06-07 05:55:26Z ltheussl $
*/
public class ChapterXdocBookSink
extends AbstractXdocBookSink
{
/** the chapter IndexEntry. */
private final IndexEntry chapterIndex;
/**
* Default constructor.
*
* @param out the Writer.
* @param chapterIndex the chapter IndexEntry.
* @param i18n I18N.
* @param locale wanted locale.
*/
public ChapterXdocBookSink( Writer out, IndexEntry chapterIndex, I18N i18n, Locale locale )
{
super( out, i18n, locale );
this.chapterIndex = chapterIndex;
}
/** {@inheritDoc} */
protected void navigationPanel()
{
write( "" );
write( "
" );
// -----------------------------------------------------------------------
// Next
// -----------------------------------------------------------------------
write( "
" );
next();
write( "
" );
write( "
" );
write( "
" );
write( "" );
}
/**
* Add previous link.
*
* @param prevChapter the previous IndexEntry.
*/
protected void previous( IndexEntry prevChapter )
{
if ( prevChapter != null )
{
IndexEntry lastEntry = prevChapter.getLastEntry();
if ( lastEntry == null )
{
write( "Start of book" );
}
else
{
write( getString( "previous" ) + ": " );
content( lastEntry.getTitle() );
write( "" );
}
}
else
{
write( getString( "previous" ) + ":" + getString( "toc" ) + "" );
}
}
/**
* Add parent/up link.
*/
protected void up()
{
write( getString( "up" ) + ": " + getString( "toc" ) + "" );
}
/**
* Add next link
*/
protected void next()
{
IndexEntry firstEntry = chapterIndex.getFirstEntry();
if ( firstEntry == null )
{
write( "End of book" );
}
else
{
write( getString( "next" ) + ": " );
content( firstEntry.getTitle() );
write( "" );
}
}
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xdoc/SectionXdocB0000644 0001750 0001750 00000011542 11212653116 033261 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.xdoc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Writer;
import java.util.Locale;
import org.apache.maven.doxia.index.IndexEntry;
import org.codehaus.plexus.i18n.I18N;
/**
* A XdocSink implementation for section in a book
*
* @author Vincent Siveton
* @version $Id: SectionXdocBookSink.java 782330 2009-06-07 05:55:26Z ltheussl $
*/
public class SectionXdocBookSink
extends AbstractXdocBookSink
{
/** indexEntry. */
private final IndexEntry indexEntry;
/**
* Default constructor.
*
* @param out the Writer to use.
* @param indexEntry the IndexEntry.
* @param i18n the I18N.
* @param locale wanted locale.
*/
public SectionXdocBookSink( Writer out, IndexEntry indexEntry, I18N i18n, Locale locale )
{
super( out, i18n, locale );
this.indexEntry = indexEntry;
}
/** {@inheritDoc} */
protected void navigationPanel()
{
write( "" );
write( "
" );
write( "" );
}
/**
* Add previous link.
*
* @param parent the parent IndexEntry.
* @param prevEntry the previous IndexEntry.
*/
protected void previous( IndexEntry parent, IndexEntry prevEntry )
{
if ( prevEntry != null )
{
write( getString( "previous" ) + ": " );
content( prevEntry.getTitle() );
write( "" );
}
else
{
write( getString( "previous" ) + ": " );
content( parent.getTitle() );
write( "" );
}
}
/**
* Add parent/up link.
*
* @param parent the parent IndexEntry.
* @see org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink#up()
*/
protected void up( IndexEntry parent )
{
write( getString( "up" ) + ": " + parent.getTitle() + "" );
}
/**
* Add next link.
*
* @param parent the parent IndexEntry.
* @param nextEntry the next IndexEntry.
*/
protected void next( IndexEntry parent, IndexEntry nextEntry )
{
if ( nextEntry != null )
{
write( getString( "next" ) + ": " );
content( nextEntry.getTitle() );
write( "" );
}
else
{
IndexEntry nextChapter = parent.getNextEntry();
if ( nextChapter == null )
{
write( "End of book" );
}
else
{
write( getString( "next" ) + ": " );
content( nextChapter.getTitle() );
write( "" );
}
}
}
}
././@LongLink 0000000 0000000 0000000 00000000150 00000000000 011561 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/RtfBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/RtfBookRenderer.j0000644 0001750 0001750 00000003236 10767707462 033310 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import org.apache.maven.doxia.module.itext.ITextUtil;
/**
* RTF book renderer with the iText framework.
*
* @plexus.component role-hint="rtf"
*
* @author Vincent Siveton
* @version $Id: RtfBookRenderer.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public class RtfBookRenderer
extends AbstractITextBookRenderer
{
/** {@inheritDoc} */
public String getOutputExtension()
{
return "rtf";
}
/** {@inheritDoc} */
public void renderXML( File iTextFile, File iTextOutput )
throws IOException
{
ITextUtil.writeRtf( new FileInputStream( iTextFile ), new FileOutputStream( iTextOutput ) );
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/ 0000755 0001750 0001750 00000000000 11632765560 031223 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000154 00000000000 011565 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/xhtml/XhtmlBookSi0000644 0001750 0001750 00000011005 11245330573 033336 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.xhtml;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.xhtml.XhtmlSink;
import org.apache.maven.doxia.sink.render.RenderingContext;
import org.codehaus.plexus.util.StringUtils;
import java.io.Writer;
/**
* An Xhtml Sink that doesn't write out head or body elements.
*
* @author ltheussl
* @version $Id: XhtmlBookSink.java 808201 2009-08-26 22:04:43Z vsiveton $
*/
public class XhtmlBookSink
extends XhtmlSink
{
private RenderingContext renderingContext;
/**
* Construct a new XhtmlBookSink.
*
* @param out the writer for the sink.
* @param context the RenderingContext.
*/
public XhtmlBookSink( Writer out, RenderingContext context )
{
super( out );
this.renderingContext = context;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void head()
{
init();
setHeadFlag( true );
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void head_()
{
setHeadFlag( false );
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void title()
{
// noop
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void title_()
{
resetTextBuffer();
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void author_()
{
resetTextBuffer();
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void date_()
{
resetTextBuffer();
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void body()
{
// noop
}
/**
* {@inheritDoc}
*
* Does nothing.
*/
public void body_()
{
// noop
}
/**
* Calls super.head().
*/
public void bookHead()
{
super.head();
}
/**
* Calls super.head_().
*/
public void bookHead_()
{
super.head_();
}
/**
* Calls super.title().
*/
public void bookTitle()
{
super.title();
}
/**
* Calls super.title_().
*/
public void bookTitle_()
{
super.title_();
}
/**
* Calls super.author().
*/
public void bookAuthor()
{
super.author();
}
/**
* Calls super.author_().
*/
public void bookAuthor_()
{
super.author_();
}
/**
* Calls super.date().
*/
public void bookDate()
{
super.date();
}
/**
* Calls super.date_().
*/
public void bookDate_()
{
super.date_();
}
/**
* Calls super.body().
*/
public void bookBody()
{
super.body();
}
/**
* Calls super.body_().
*/
public void bookBody_()
{
super.body_();
}
/** {@inheritDoc} */
public void sectionTitle()
{
writeStartTag( H1 );
}
/** {@inheritDoc} */
public void sectionTitle_()
{
writeEndTag( H1 );
}
/** {@inheritDoc} */
protected void write( String text )
{
if ( renderingContext != null )
{
String relativePathToBasedir = renderingContext.getRelativePath();
if ( relativePathToBasedir == null )
{
text = StringUtils.replace( text, "$relativePath", "." );
}
else
{
text = StringUtils.replace( text, "$relativePath", relativePathToBasedir );
}
}
super.write( text );
}
}
././@LongLink 0000000 0000000 0000000 00000000151 00000000000 011562 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XdocBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/XdocBookRenderer.0000644 0001750 0001750 00000035352 11451074657 033276 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.util.Iterator;
import java.util.Locale;
import org.apache.maven.doxia.Doxia;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.book.services.renderer.xdoc.ChapterXdocBookSink;
import org.apache.maven.doxia.book.services.renderer.xdoc.IndexXdocBookSink;
import org.apache.maven.doxia.book.services.renderer.xdoc.SectionXdocBookSink;
import org.apache.maven.doxia.index.IndexEntry;
import org.apache.maven.doxia.module.xdoc.XdocSink;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.i18n.I18N;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.WriterFactory;
/**
* An implementation of BookRenderer for Xdoc
*
* @author Trygve Laugstøl
* @author Vincent Siveton
* @version $Id: XdocBookRenderer.java 1003021 2010-09-30 11:51:11Z ltheussl $
* @plexus.component role-hint="xdoc"
*/
public class XdocBookRenderer
extends AbstractLogEnabled
implements BookRenderer
{
/**
* @plexus.requirement
*/
private Doxia doxia;
/**
* @plexus.requirement
*/
private I18N i18n;
// ----------------------------------------------------------------------
// BookRenderer Implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void renderBook( BookContext context )
throws BookDoxiaException
{
BookModel book = context.getBook();
if ( !context.getOutputDirectory().exists() )
{
if ( !context.getOutputDirectory().mkdirs() )
{
throw new BookDoxiaException( "Could not make directory: "
+ context.getOutputDirectory().getAbsolutePath() + "." );
}
}
renderBook( book, context );
}
// -----------------------------------------------------------------------
// Protected
// -----------------------------------------------------------------------
/**
* Gets a trimmed String for the given key from the resource bundle defined by Plexus.
*
* @param locale the locale used
* @param key the key for the desired string
* @return the string for the given key and the given locale
*/
protected String getString( Locale locale, String key )
{
if ( StringUtils.isEmpty( key ) )
{
throw new IllegalArgumentException( "The key cannot be empty" );
}
return i18n.getString( "book-renderer", locale, key ).trim();
}
// -----------------------------------------------------------------------
// Private
// -----------------------------------------------------------------------
/**
* Render the book, ie the book index and all chapter index and pages
*
* @param book the BookModel.
* @param context the BookContext.
* @throws BookDoxiaException if any
*/
private void renderBook( BookModel book, BookContext context )
throws BookDoxiaException
{
// -----------------------------------------------------------------------
// Render the book index.xml page
// -----------------------------------------------------------------------
File index = new File( context.getOutputDirectory(), "index.xml" );
try
{
writeBookIndex( index, book, context );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering index page to: '"
+ index.getAbsolutePath() + "'.", e );
}
// -----------------------------------------------------------------------
// Render all the chapter pages
// -----------------------------------------------------------------------
Iterator ii = context.getIndex().getChildEntries().iterator();
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
renderChapter( chapter, context, (IndexEntry) ii.next() );
}
}
/**
* Write the book index, ie a TOC.
*
* @param index the File.
* @param book the BookModel.
* @param context the BookContext.
* @throws IOException if any
*/
private void writeBookIndex( File index, BookModel book, BookContext context )
throws IOException
{
Writer writer = WriterFactory.newXmlWriter( index );
XdocSink sink = new IndexXdocBookSink( writer, context.getIndex().getFirstEntry(), i18n, context.getLocale() );
try
{
// -----------------------------------------------------------------------
// Head
// -----------------------------------------------------------------------
sink.head();
sink.title();
sink.text( book.getTitle() + " - " + getString( context.getLocale(), "toc" ) );
sink.title_();
sink.head_();
// -----------------------------------------------------------------------
// Body
// -----------------------------------------------------------------------
sink.body();
sink.section1();
sink.sectionTitle1();
sink.text( book.getTitle() + " - " + getString( context.getLocale(), "toc" ) );
sink.sectionTitle1_();
sink.list();
for ( Iterator it = context.getIndex().getChildEntries().iterator(); it.hasNext(); )
{
writeChapterIndexForBookIndex( sink, (IndexEntry) it.next() );
}
sink.list_();
sink.section1_();
sink.body_();
}
finally
{
sink.flush();
sink.close();
IOUtil.close( writer );
}
}
/**
* Write the chapter index for the book index.
*
* @param sink the XdocSink.
* @param chapterEntry the chapter IndexEntry.
*/
private void writeChapterIndexForBookIndex( XdocSink sink, IndexEntry chapterEntry )
{
sink.listItem();
sink.link( chapterEntry.getId() + ".html" );
sink.text( chapterEntry.getTitle() );
sink.link_();
sink.list();
for ( Iterator it = chapterEntry.getChildEntries().iterator(); it.hasNext(); )
{
IndexEntry sectionIndex = (IndexEntry) it.next();
writeSectionIndexForBookIndex( sink, sectionIndex );
}
sink.list_();
sink.listItem_();
}
/**
* Write the section index for the book index.
*
* @param sink the XdocSink.
* @param sectionIndex the section IndexEntry.
*/
private void writeSectionIndexForBookIndex( XdocSink sink, IndexEntry sectionIndex )
{
sink.listItem();
sink.link( sectionIndex.getId() + ".html" );
sink.text( sectionIndex.getTitle() );
sink.link_();
sink.list();
for ( Iterator it = sectionIndex.getChildEntries().iterator(); it.hasNext(); )
{
IndexEntry subsectionIndex = (IndexEntry) it.next();
writeSubsectionIndexForBookIndex( sink, sectionIndex, subsectionIndex );
}
sink.list_();
sink.listItem_();
}
/**
* Write subsection index for the book index.
*
* @param sink the XdocSink.
* @param sectionIndex the section IndexEntry.
* @param subsectionIndex the subsection IndexEntry.
*/
private void writeSubsectionIndexForBookIndex( XdocSink sink, IndexEntry sectionIndex, IndexEntry subsectionIndex )
{
sink.listItem();
sink.link( sectionIndex.getId() + ".html#" + HtmlTools.encodeId( subsectionIndex.getId() ) );
sink.text( subsectionIndex.getTitle() );
sink.link_();
sink.listItem_();
}
// -----------------------------------------------------------------------
// Rendering
// -----------------------------------------------------------------------
/**
* Render the chapter index and all section pages.
*
* @param chapter the Chapter.
* @param context the BookContext.
* @param chapterIndex the IndexEntry.
* @throws BookDoxiaException if any
*/
private void renderChapter( Chapter chapter, BookContext context, IndexEntry chapterIndex )
throws BookDoxiaException
{
// -----------------------------------------------------------------------
// Render the chapter index page
// -----------------------------------------------------------------------
File index = new File( context.getOutputDirectory(), chapter.getId() + ".xml" );
try
{
writeChapterIndex( index, chapter, chapterIndex, context );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering index page to: '"
+ index.getAbsolutePath() + "'.", e );
}
// -----------------------------------------------------------------------
// Render all section pages
// -----------------------------------------------------------------------
Iterator ii = chapterIndex.getChildEntries().iterator();
for ( Iterator it = chapter.getSections().iterator(); it.hasNext(); )
{
Section section = (Section) it.next();
renderSection( context, section, (IndexEntry) ii.next() );
}
}
/**
* Write a chapter index
*
* @param index the File.
* @param context the context.
* @param chapter the Chapter.
* @param chapterIndex the IndexEntry.
* @throws IOException if any.
*/
private void writeChapterIndex( File index, Chapter chapter, IndexEntry chapterIndex, BookContext context )
throws IOException
{
Writer writer = WriterFactory.newXmlWriter( index );
ChapterXdocBookSink sink = new ChapterXdocBookSink( writer, chapterIndex, i18n, context.getLocale() );
try
{
// -----------------------------------------------------------------------
// Head
// -----------------------------------------------------------------------
sink.head();
sink.title();
sink.text( chapter.getTitle() );
sink.title_();
sink.head_();
// -----------------------------------------------------------------------
// Body
// -----------------------------------------------------------------------
sink.body();
sink.section1();
sink.sectionTitle1();
sink.text( chapter.getTitle() );
sink.sectionTitle1_();
sink.list();
for ( Iterator it = chapterIndex.getChildEntries().iterator(); it.hasNext(); )
{
IndexEntry sectionIndex = (IndexEntry) it.next();
writeSectionIndexForBookIndex( sink, sectionIndex );
}
sink.list_();
sink.section1_();
sink.body_();
}
finally
{
sink.flush();
sink.close();
IOUtil.close( writer );
}
}
/**
* Render all section pages.
*
* @param context the BookContext.
* @param section the Section.
* @param sectionIndex the IndexEntry.
* @throws BookDoxiaException if any.
*/
private void renderSection( BookContext context, Section section, IndexEntry sectionIndex )
throws BookDoxiaException
{
try
{
Writer writer = WriterFactory.newXmlWriter( new File( context.getOutputDirectory()
+ "/" + section.getId() + ".xml" ) );
SectionXdocBookSink sink = new SectionXdocBookSink( writer, sectionIndex, i18n, context.getLocale() );
BookContext.BookFile bookFile = (BookContext.BookFile) context.getFiles().get( section.getId() );
if ( bookFile == null )
{
throw new BookDoxiaException( "No document that matches section with id=" + section.getId() + "." );
}
Reader reader = null;
try
{
reader = ReaderFactory.newReader( bookFile.getFile(), context.getInputEncoding() );
doxia.parse( reader, bookFile.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
throw new BookDoxiaException( "Parser not found: " + bookFile.getParserId() + ".", e );
}
catch ( ParseException e )
{
throw new BookDoxiaException( "Error while parsing document: " + bookFile.getFile().getAbsolutePath()
+ ".", e );
}
catch ( FileNotFoundException e )
{
throw new BookDoxiaException( "Could not find document: " + bookFile.getFile().getAbsolutePath() + ".",
e );
}
finally
{
sink.flush();
sink.close();
IOUtil.close( reader );
IOUtil.close( writer );
}
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering book.", e );
}
}
}
././@LongLink 0000000 0000000 0000000 00000000150 00000000000 011561 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/PdfBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/PdfBookRenderer.j0000644 0001750 0001750 00000003236 10767707462 033266 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import org.apache.maven.doxia.module.itext.ITextUtil;
/**
* PDF book renderer with the iText framework.
*
* @plexus.component role-hint="pdf"
*
* @author Vincent Siveton
* @version $Id: PdfBookRenderer.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public class PdfBookRenderer
extends AbstractITextBookRenderer
{
/** {@inheritDoc} */
public String getOutputExtension()
{
return "pdf";
}
/** {@inheritDoc} */
public void renderXML( File iTextFile, File iTextOutput )
throws IOException
{
ITextUtil.writePdf( new FileInputStream( iTextFile ), new FileOutputStream( iTextOutput ) );
}
}
././@LongLink 0000000 0000000 0000000 00000000154 00000000000 011565 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/DocbookBookRender0000644 0001750 0001750 00000016156 11451074657 033355 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.util.Iterator;
import org.apache.maven.doxia.Doxia;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.book.services.renderer.docbook.DocBookBookSink;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.WriterFactory;
/**
* An implementation of BookRenderer for docbook
*
* @plexus.component role-hint="doc-book"
* @author Eric Redmond
* @version $Id: DocbookBookRenderer.java 1003021 2010-09-30 11:51:11Z ltheussl $
*/
public class DocbookBookRenderer
extends AbstractLogEnabled
implements BookRenderer
{
/**
* @plexus.requirement
*/
private Doxia doxia;
// ----------------------------------------------------------------------
// BookRenderer Implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void renderBook( BookContext context )
throws BookDoxiaException
{
BookModel book = context.getBook();
if ( !context.getOutputDirectory().exists() )
{
if ( !context.getOutputDirectory().mkdirs() )
{
throw new BookDoxiaException( "Could not make directory: "
+ context.getOutputDirectory().getAbsolutePath() + "." );
}
}
File bookFile = new File( context.getOutputDirectory(), book.getId() + ".xml" );
Writer fileWriter;
try
{
fileWriter = WriterFactory.newXmlWriter( bookFile );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while opening file.", e );
}
// ----------------------------------------------------------------------
// Create the Dockbook File
// ----------------------------------------------------------------------
// TODO: Write out TOC?
DocBookBookSink sink = new DocBookBookSink( fileWriter );
try
{
sink.book();
// TODO: symmetrize bookHead?
if ( StringUtils.isNotEmpty( book.getTitle() ) )
{
sink.bookTitle();
sink.text( book.getTitle() );
sink.bookTitle_();
}
if ( StringUtils.isNotEmpty( book.getDate() ) )
{
sink.bookDate();
sink.text( book.getDate() );
sink.bookDate_();
}
if ( StringUtils.isNotEmpty( book.getAuthor() ) )
{
sink.bookAuthor();
sink.text( book.getAuthor() );
sink.bookAuthor_();
}
sink.bookHead_();
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
sink.chapter();
if ( StringUtils.isNotEmpty( chapter.getTitle() ) )
{
sink.chapterTitle();
sink.text( chapter.getTitle() );
sink.chapterTitle_();
}
renderChapter( chapter, context, sink );
sink.chapter_();
}
sink.book_();
}
finally
{
sink.flush();
sink.close();
IOUtil.close( fileWriter );
}
}
/**
* Write a chapter.
*
* @param writer the writer.
* @param chapter the Chapter.
* @param context the BookContext.
* @param sink a Sink.
* @throws BookDoxiaException if the chapter cannot be written.
*/
private void renderChapter( Chapter chapter, BookContext context, Sink sink )
throws BookDoxiaException
{
for ( Iterator it = chapter.getSections().iterator(); it.hasNext(); )
{
Section section = (Section) it.next();
renderSection( section, context, sink );
}
}
/**
* Write a section.
*
* @param writer the writer.
* @param section the Section.
* @param context the BookContext.
* @param sink a Sink.
* @throws BookDoxiaException if the section cannot be written.
*/
private void renderSection( Section section, BookContext context, Sink sink )
throws BookDoxiaException
{
BookContext.BookFile bookFile = (BookContext.BookFile) context.getFiles().get( section.getId() );
if ( bookFile == null )
{
throw new BookDoxiaException( "No document that matches section with id=" + section.getId() + "." );
}
Reader reader = null;
try
{
reader = ReaderFactory.newReader( bookFile.getFile(), context.getInputEncoding() );
doxia.parse( reader, bookFile.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
throw new BookDoxiaException( "Parser not found: " + bookFile.getParserId() + ".", e );
}
catch ( ParseException e )
{
throw new BookDoxiaException(
"Error while parsing document: " + bookFile.getFile().getAbsolutePath() + ".",
e );
}
catch ( FileNotFoundException e )
{
throw new BookDoxiaException( "Could not find document: " + bookFile.getFile().getAbsolutePath() + ".", e );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering book: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
finally
{
IOUtil.close( reader );
}
}
}
././@LongLink 0000000 0000000 0000000 00000000162 00000000000 011564 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBookRenderer.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/AbstractITextBook0000644 0001750 0001750 00000030327 11451074657 033352 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.text.DateFormat;
import java.util.Date;
import java.util.Iterator;
import org.apache.maven.doxia.Doxia;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import org.apache.maven.doxia.book.model.Section;
import org.apache.maven.doxia.module.itext.ITextSinkFactory;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.WriterFactory;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
/**
* Base class for iText renderer.
*
* @author Trygve Laugstøl
* @author Vincent Siveton
* @version $Id: AbstractITextBookRenderer.java 1003021 2010-09-30 11:51:11Z ltheussl $
*/
public abstract class AbstractITextBookRenderer
extends AbstractLogEnabled
implements BookRenderer
{
/**
* @plexus.requirement
*/
private Doxia doxia;
// ----------------------------------------------------------------------
// BookRenderer Implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void renderBook( BookContext context )
throws BookDoxiaException
{
BookModel book = context.getBook();
if ( !context.getOutputDirectory().exists() )
{
if ( !context.getOutputDirectory().mkdirs() )
{
throw new BookDoxiaException( "Could not make directory: "
+ context.getOutputDirectory().getAbsolutePath() + "." );
}
}
File bookFile = new File( context.getOutputDirectory(), book.getId() + ".xml" );
Writer fileWriter;
try
{
fileWriter = WriterFactory.newXmlWriter( bookFile );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while opening file.", e );
}
// ----------------------------------------------------------------------
// Create the XML File
// ----------------------------------------------------------------------
PrettyPrintXMLWriter writer = new PrettyPrintXMLWriter( fileWriter, "UTF-8", null );
writer.startElement( "itext" );
writer.addAttribute( "creationdate", DateFormat.getDateTimeInstance().format( new Date() ) );
writer.addAttribute( "producer", "Doxia iText" );
// writer.startElement( "paragraph" );
// writer.addAttribute( "leading", "18.0" );
// writer.addAttribute( "font", "unknown" );
// writer.addAttribute( "align", "Default" );
// writer.writeText( "Please visit my" + System.getProperty( "line.separator" ) );
//
// writer.startElement( "anchor" );
// writer.addAttribute( "leading", "18.0" );
// writer.addAttribute( "font", "Helvetica" );
// writer.addAttribute( "size", "12.0" );
// writer.addAttribute( "fontstyle", "normal, underline" );
// writer.addAttribute( "red", "0" );
// writer.addAttribute( "green", "0" );
// writer.addAttribute( "blue", "255" );
// writer.addAttribute( "name", "top" );
// writer.addAttribute( "reference", "http://www.lowagie.com/iText/" );
//
// writer.startElement( "chunk" );
// writer.addAttribute( "font", "Helvetica" );
// writer.addAttribute( "size", "12.0" );
// writer.addAttribute( "fontstyle", "normal, underline" );
// writer.addAttribute( "red", "0" );
// writer.addAttribute( "green", "0" );
// writer.addAttribute( "blue", "255" );
// writer.writeText( "website (external reference)" );
// writer.endElement();
//
// writer.endElement(); // anchor
//
// writer.endElement(); // paragraph
// TODO: Write out TOC
System.setProperty( "itext.basedir", bookFile.getParentFile().getAbsolutePath() );
Sink sink = new ITextSinkFactory().createSink( writer );
try
{
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
renderChapter( sink, writer, chapter, context );
}
writer.endElement(); // itext
}
finally
{
sink.flush();
sink.close();
IOUtil.close( fileWriter );
System.getProperties().remove( "itext.basedir" );
}
// ----------------------------------------------------------------------
// Render the XML to PDF
// ----------------------------------------------------------------------
File outputFile = new File( context.getOutputDirectory(), book.getId() + "." + getOutputExtension() );
try
{
renderXML( bookFile, outputFile );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering file", e );
}
}
/**
* Get the output extension supported.
*
* @return the ouput extension supported.
*/
public abstract String getOutputExtension();
/**
* Generate an ouput file with the iText framework.
*
* @param iTextFile the input file.
* @param iTextOutput the output file.
* @throws java.io.IOException if any.
*/
public abstract void renderXML( File iTextFile, File iTextOutput )
throws IOException;
// ----------------------------------------------------------------------
// Private
// ----------------------------------------------------------------------
/**
* Write a chapter.
*
* @param writer the writer.
* @param chapter the Chapter.
* @param context the BookContext.
* @throws BookDoxiaException if the chapter cannot be written.
*/
private void renderChapter( Sink sink, PrettyPrintXMLWriter writer, Chapter chapter, BookContext context )
throws BookDoxiaException
{
writer.startElement( "chapter" );
writer.addAttribute( "numberdepth", "1" );
writer.addAttribute( "depth", "1" );
writer.addAttribute( "indent", "1" );
startTitle( writer, "36.0", "Helvetica", "24.0", "normal", "255", "0", "0" );
chunk( writer, chapter.getTitle(), "Helvetica", "24.0", "normal", "255", "0", "0" );
writer.endElement(); // title
// writer.startElement( "sectioncontent" );
for ( Iterator it = chapter.getSections().iterator(); it.hasNext(); )
{
Section section = (Section) it.next();
renderSection( sink, writer, section, context );
}
// writer.endElement(); // sectioncontent
writer.endElement(); // chapter
}
/**
* Write a section.
*
* @param writer the writer.
* @param section the Section.
* @param context the BookContext.
* @throws BookDoxiaException if the section cannot be written.
*/
private void renderSection( Sink sink, PrettyPrintXMLWriter writer, Section section, BookContext context )
throws BookDoxiaException
{
// writer.startElement( "section" );
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
BookContext.BookFile bookFile = (BookContext.BookFile) context.getFiles().get( section.getId() );
if ( bookFile == null )
{
throw new BookDoxiaException( "No document that matches section with id=" + section.getId() + "." );
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
Reader reader = null;
try
{
reader = ReaderFactory.newReader( bookFile.getFile(), context.getInputEncoding() );
doxia.parse( reader, bookFile.getParserId(), sink );
}
catch ( ParserNotFoundException e )
{
throw new BookDoxiaException( "Parser not found: " + bookFile.getParserId() + ".", e );
}
catch ( ParseException e )
{
throw new BookDoxiaException(
"Error while parsing document: " + bookFile.getFile().getAbsolutePath() + ".",
e );
}
catch ( FileNotFoundException e )
{
throw new BookDoxiaException( "Could not find document: " + bookFile.getFile().getAbsolutePath() + ".", e );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while rendering book: "
+ bookFile.getFile().getAbsolutePath() + ".", e );
}
finally
{
IOUtil.close( reader );
}
}
/**
* Start a title.
*
* @param writer the writer.
* @param leading leading.
* @param font the font.
* @param size the size.
* @param fontstyle the fontstyle.
* @param red red.
* @param green green.
* @param blue blue.
*/
private void startTitle( PrettyPrintXMLWriter writer, String leading, String font, String size, String fontstyle,
String red, String green, String blue )
{
writer.startElement( "title" );
writer.addAttribute( "leading", leading );
writer.addAttribute( "font", font );
writer.addAttribute( "size", size );
writer.addAttribute( "fontstyle", fontstyle );
writer.addAttribute( "red", red );
writer.addAttribute( "green", green );
writer.addAttribute( "blue", blue );
}
/**
* Write a chunk.
*
* @param writer the writer.
* @param title the title.
* @param font the font.
* @param size the size.
* @param fontstyle the fontstyle.
* @param red red.
* @param green green.
* @param blue blue.
*/
private void chunk( PrettyPrintXMLWriter writer, String title, String font, String size, String fontstyle,
String red, String green, String blue )
{
writer.startElement( "chunk" );
writer.addAttribute( "font", font );
writer.addAttribute( "size", size );
writer.addAttribute( "fontstyle", fontstyle );
writer.addAttribute( "red", red );
writer.addAttribute( "green", green );
writer.addAttribute( "blue", blue );
if ( StringUtils.isNotEmpty( title ) )
{
writer.writeText( title );
}
else
{
writer.writeText( "" );
}
writer.endElement(); // chunk
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/ 0000755 0001750 0001750 00000000000 11632765560 031204 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000154 00000000000 011565 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSink.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/renderer/latex/LatexBookSi0000644 0001750 0001750 00000006327 11175620077 033316 0 ustar twerner twerner package org.apache.maven.doxia.book.services.renderer.latex;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.latex.LatexSink;
import java.io.Writer;
/**
*
LatexBookSink class.
*
* @author Trygve Laugstøl
* @version $Id: LatexBookSink.java 769433 2009-04-28 15:26:55Z ltheussl $
*/
public class LatexBookSink
extends LatexSink
{
/** text. */
private String txt;
/** title. */
private String title;
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* Construct a new LatexBookSink which is a LatexSink with the given writer,
* null sinkCommands, null preamble and fragmentDocument = true.
*
* @param out the writer for the sink.
*/
public LatexBookSink( Writer out )
{
super( out, null, null, true );
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/** {@inheritDoc} */
protected String getDocumentStart()
{
return "";
// return "\\documentclass{book}";
}
/** {@inheritDoc} */
protected String getDocumentBegin()
{
return null;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void text( String text )
{
this.txt = text;
super.text( text );
}
/** {@inheritDoc} */
public void title_()
{
super.title_();
this.title = txt;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* Return the title.
*
* @return String.
*/
public String getTitle()
{
return title;
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* Writes the default LaTeX commands and preamble in the main book file.
*
* @since 1.1
*/
public void defaultBookPreamble()
{
markup( defaultSinkCommands() );
markup( defaultPreamble() );
flush();
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/ 0000755 0001750 0001750 00000000000 11632765560 030413 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000153 00000000000 011564 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/ValidationResult.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/ValidationResul0000644 0001750 0001750 00000004153 10767707462 033453 0 ustar twerner twerner package org.apache.maven.doxia.book.services.validation;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import java.util.ArrayList;
/**
* Encapsulates the result of a validation.
*
* @author Trygve Laugstøl
* @version $Id: ValidationResult.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public class ValidationResult
{
/** If all is OK. */
private boolean allOk;
/** List of errors. */
private List errors;
/** List of warnings. */
private List warnings;
/**
* Checks if there were any errors or warnings.
*
* @return True if there were no errors or warnings.
*/
public boolean isAllOk()
{
return getErrors().size() == 0 && getWarnings().size() == 0;
}
/**
* Return the list of errors.
*
* @return List. A new ArrayList is constructed if the current List is null.
*/
public List getErrors()
{
if ( errors == null )
{
errors = new ArrayList();
}
return errors;
}
/**
* Return the list of warnings.
*
* @return List. A new ArrayList is constructed if the current List is null.
*/
public List getWarnings()
{
if ( warnings == null )
{
warnings = new ArrayList();
}
return warnings;
}
}
././@LongLink 0000000 0000000 0000000 00000000150 00000000000 011561 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/BookValidator.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/BookValidator.j0000644 0001750 0001750 00000002605 10767707462 033336 0 ustar twerner twerner package org.apache.maven.doxia.book.services.validation;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.model.BookModel;
/**
* Ensure a BookModel is valid.
*
* @author Trygve Laugstøl
* @version $Id: BookValidator.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public interface BookValidator
{
/** The plexus lookup role. */
String ROLE = BookValidator.class.getName();
/**
* Validate a BookModel.
*
* @param book the BookModel to validate.
* @return ValidationResult
*/
ValidationResult validateBook( BookModel book );
}
././@LongLink 0000000 0000000 0000000 00000000157 00000000000 011570 L ustar root root doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/DefaultBookValidator.java doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/validation/DefaultBookVali0000644 0001750 0001750 00000006574 10767707462 033372 0 ustar twerner twerner package org.apache.maven.doxia.book.services.validation;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.codehaus.plexus.logging.AbstractLogEnabled;
import org.codehaus.plexus.util.StringUtils;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.model.Chapter;
import java.util.Iterator;
/**
* Default implementation of BookValidator.
*
* @plexus.component
*
* @author Trygve Laugstøl
* @version $Id: DefaultBookValidator.java 638290 2008-03-18 09:45:22Z bentmann $
*/
public class DefaultBookValidator
extends AbstractLogEnabled
implements BookValidator
{
// ----------------------------------------------------------------------
// BookValidator Implementation
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public ValidationResult validateBook( BookModel book )
{
ValidationResult result = new ValidationResult();
if ( StringUtils.isEmpty( book.getId() ) )
{
result.getErrors().add( "Book is missing id." );
}
if ( StringUtils.isEmpty( book.getTitle() ) )
{
result.getErrors().add( "Book is missing title." );
}
if ( book.getChapters().size() == 0 )
{
result.getErrors().add( "The book must have at least one chaper" );
}
else
{
for ( Iterator it = book.getChapters().iterator(); it.hasNext(); )
{
Chapter chapter = (Chapter) it.next();
validateChapter( result, chapter );
// TODO: Validate the chapter id
}
}
return result;
}
// ----------------------------------------------------------------------
// Private
// ----------------------------------------------------------------------
/**
* Validate a Chapter.
*
* @param result the ValidationResult to receive the results.
* @param chapter the chapter to validate.
*/
private void validateChapter( ValidationResult result, Chapter chapter )
{
if ( StringUtils.isEmpty( chapter.getId() ) )
{
result.getErrors().add( "Each chapter has to have an id." );
return;
}
if ( StringUtils.isEmpty( chapter.getTitle() ) )
{
result.getErrors().add( "Missing title. Chapter id: " + chapter.getId() );
}
if ( chapter.getSections().size() == 0 )
{
result.getErrors().add( "Chapter doesn't have any sections. Chapter id: " + chapter.getId() );
}
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/ 0000755 0001750 0001750 00000000000 11632765560 026670 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/BookIo.java 0000644 0001750 0001750 00000003542 11150511552 030702 0 ustar twerner twerner package org.apache.maven.doxia.book.services.io;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import java.io.File;
import java.util.List;
/**
* Common book-related IO methods.
*
* @author Trygve Laugstøl
* @version $Id: BookIo.java 746976 2009-02-23 12:15:38Z vsiveton $
*/
public interface BookIo
{
/** The plexus lookup role. */
String ROLE = BookIo.class.getName();
/**
* Read a BookModel from a descriptor file.
*
* @param bookDescriptor the book descriptor file.
* @return BookModel
* @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be read.
*/
BookModel readBook( File bookDescriptor )
throws BookDoxiaException;
/**
* Loads files in a given context.
*
* @param context the BookContext.
* @param files a list of files.
*/
void loadFiles( BookContext context, List files );
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/services/io/DefaultBookIo.java 0000644 0001750 0001750 00000012443 11175620077 032221 0 ustar twerner twerner package org.apache.maven.doxia.book.services.io;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.model.io.xpp3.BookModelXpp3Reader;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.context.BookContext;
import org.apache.maven.doxia.module.site.SiteModule;
import org.apache.maven.doxia.module.site.manager.SiteModuleManager;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import java.io.IOException;
import java.io.File;
import java.io.Reader;
import java.util.Collection;
import java.util.Iterator;
import java.util.Map;
import java.util.TreeMap;
import java.util.List;
/**
*
DefaultBookIo class.
*
* @plexus.component
* @author Trygve Laugstøl
* @version $Id: DefaultBookIo.java 769433 2009-04-28 15:26:55Z ltheussl $
*/
public class DefaultBookIo
extends AbstractLogEnabled
implements BookIo
{
/**
* @plexus.requirement
*/
private SiteModuleManager siteModuleManager;
// -----------------------------------------------------------------------
// DefaultBookIo Implementation
// -----------------------------------------------------------------------
/** {@inheritDoc} */
public BookModel readBook( File bookDescriptor )
throws BookDoxiaException
{
Reader reader = null;
try
{
reader = ReaderFactory.newXmlReader( bookDescriptor );
return new BookModelXpp3Reader().read( reader, true );
}
catch ( IOException e )
{
throw new BookDoxiaException( "Error while reading book descriptor.", e );
}
catch ( XmlPullParserException e )
{
throw new BookDoxiaException( "Error while reading book descriptor.", e );
}
finally
{
IOUtil.close( reader );
}
}
/** {@inheritDoc} */
public void loadFiles( BookContext context, List files )
{
// ----------------------------------------------------------------------
// Find all the files, map the file names to ids
// ----------------------------------------------------------------------
Collection siteModules = siteModuleManager.getSiteModules();
for ( Iterator it = siteModules.iterator(); it.hasNext(); )
{
SiteModule siteModule = (SiteModule) it.next();
String extension = siteModule.getExtension();
String sourceDirectory = File.separator + siteModule.getSourceDirectory() + File.separator;
String parserId = siteModule.getParserId();
for ( Iterator j = files.iterator(); j.hasNext(); )
{
File file = (File) j.next();
String name = file.getName();
String path = file.getAbsolutePath();
// first check if the file path contains one of the recognized source dir identifiers
// (there's trouble if a pathname contains 2 identifiers), then match file extensions (not unique).
if ( path.indexOf( sourceDirectory ) != -1 )
{
name = name.substring( 0, name.length() - extension.length() - 1 );
context.getFiles().put( name, new BookContext.BookFile( file, parserId ) );
}
else if ( name.endsWith( extension ) )
{
name = name.substring( 0, name.length() - extension.length() - 1 );
// don't overwrite if it's there already
if ( !context.getFiles().containsKey( name ) )
{
context.getFiles().put( name, new BookContext.BookFile( file, parserId ) );
}
}
}
}
if ( getLogger().isDebugEnabled() )
{
getLogger().debug( "Dumping document <-> id mapping:" );
Map map = new TreeMap( context.getFiles() );
for ( Iterator it = map.entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
BookContext.BookFile file = (BookContext.BookFile) entry.getValue();
getLogger().debug( " " + entry.getKey() + "=" + file.getFile() + ", parser: " + file.getParserId() );
}
}
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/BookDoxia.java 0000644 0001750 0001750 00000006030 11151514446 027146 0 ustar twerner twerner package org.apache.maven.doxia.book;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.model.BookModel;
import java.io.File;
import java.util.List;
import java.util.Locale;
/**
* An interface to create books in different output formats from a book descriptor.
*
* @author Trygve Laugstøl
* @version $Id: BookDoxia.java 748141 2009-02-26 13:29:10Z vsiveton $
*/
public interface BookDoxia
{
/** The plexus lookup role. */
String ROLE = BookDoxia.class.getName();
/**
* Load a BookModel from a descriptor file.
*
* @param bookDescriptor the book descriptor file.
* @return BookModel
* @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
*/
BookModel loadBook( File bookDescriptor )
throws BookDoxiaException;
/**
* Creates a book from a BookModel using the {@link Locale#getDefault()} and UTF-8 as default encoding.
*
* @param book the BookModel.
* @param bookRendererId the id of the output format.
* @param files a list of source files.
* @param outputDirectory the output directory.
* @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
* @see #renderBook(BookModel, String, List, File, Locale, String, String)
* @see Locale#getDefault()
*/
void renderBook( BookModel book, String bookRendererId, List files, File outputDirectory )
throws BookDoxiaException;
/**
* Creates a book from a BookModel.
*
* @param book the BookModel.
* @param bookRendererId the id of the output format.
* @param files a list of source files.
* @param outputDirectory the output directory.
* @param locale the wanted locale.
* @param inputEncoding the input encoding when processing files.
* @param outputEncoding the output encoding when writing files in ouputDirectory.
* @throws org.apache.maven.doxia.book.BookDoxiaException if the model cannot be loaded.
* @since 1.1
*/
void renderBook( BookModel book, String bookRendererId, List files, File outputDirectory, Locale locale,
String inputEncoding, String outputEncoding )
throws BookDoxiaException;
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/context/ 0000755 0001750 0001750 00000000000 11632765560 026122 5 ustar twerner twerner doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookIndex.java 0000644 0001750 0001750 00000002353 11150511552 030633 0 ustar twerner twerner package org.apache.maven.doxia.book.context;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.index.IndexEntry;
/**
*
BookIndex class.
*
* @author Trygve Laugstøl
* @version $Id: BookIndex.java 746976 2009-02-23 12:15:38Z vsiveton $
*/
public class BookIndex
extends IndexEntry
{
/**
* Constructs a new BookIndex.
*/
public BookIndex()
{
super( "book" );
}
}
doxia-1.1.4/doxia-book/src/main/java/org/apache/maven/doxia/book/context/BookContext.java 0000644 0001750 0001750 00000013462 11150511552 031213 0 ustar twerner twerner package org.apache.maven.doxia.book.context;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.model.BookModel;
import java.io.File;
import java.util.Locale;
import java.util.Map;
import java.util.HashMap;
/**
* Context to render a book.
*
* @author Trygve Laugstøl
* @version $Id: BookContext.java 746976 2009-02-23 12:15:38Z vsiveton $
*/
public class BookContext
{
/** The BookModel of this context. */
private BookModel book;
/** The files. */
private Map files;
/** The output directory. */
private File outputDirectory;
/** The BookIndex of this context. */
private BookIndex index;
/** The Locale used to generate the navigation. */
private Locale locale;
/** The input encoding used to read Doxia file. */
private String inputEncoding;
/** The output encoding used to write the renderer files. */
private String outputEncoding;
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/** Represents a BookFile. */
public static class BookFile
{
/** The file. */
private File file;
/** The id of the parser. */
private String parserId;
/**
* Constructor.
*
* @param file the file.
* @param parserId the parser id.
*/
public BookFile( File file, String parserId )
{
this.file = file;
this.parserId = parserId;
}
/**
* Return the file of this BookFile.
*
* @return File.
*/
public File getFile()
{
return file;
}
/**
* Return the parserId of this BookFile.
*
* @return String.
*/
public String getParserId()
{
return parserId;
}
}
// ----------------------------------------------------------------------
// Accessors
// ----------------------------------------------------------------------
/**
* Return the BookModel of this BookContext.
*
* @return BookModel.
*/
public BookModel getBook()
{
return book;
}
/**
* Set the BookModel of this BookContext.
*
* @param book the BookModel.
*/
public void setBook( BookModel book )
{
this.book = book;
}
/**
* Return the files of this BookContext.
*
* @return Map. A new HashMap is constructed if the current Map is null.
*/
public Map getFiles()
{
if ( files == null )
{
files = new HashMap();
}
return files;
}
/**
* Set the files of this BookContext.
*
* @param files the Map of files.
*/
public void setFiles( Map files )
{
this.files = files;
}
/**
* Return the outputDirectory of this BookContext.
*
* @return File.
*/
public File getOutputDirectory()
{
return outputDirectory;
}
/**
* Set the outputDirectory of this BookContext.
*
* @param outputDirectory the output directory.
*/
public void setOutputDirectory( File outputDirectory )
{
this.outputDirectory = outputDirectory;
}
/**
* Return the index of this BookContext.
*
* @return BookIndex.
*/
public BookIndex getIndex()
{
return index;
}
/**
* Set the index of this BookContext.
*
* @param index the index to set.
*/
public void setIndex( BookIndex index )
{
this.index = index;
}
/**
*
Getter for the field locale.
*
* @return the locale
* @since 1.1
*/
public Locale getLocale()
{
return locale;
}
/**
*
Setter for the field locale.
*
* @param locale the locale to set
* @since 1.1
*/
public void setLocale( Locale locale )
{
this.locale = locale;
}
/**
*
Getter for the field inputEncoding.
*
* @return the inputEncoding
* @since 1.1
*/
public String getInputEncoding()
{
return inputEncoding;
}
/**
*
Setter for the field inputEncoding.
*
* @param inputEncoding the inputEncoding to set
* @since 1.1
*/
public void setInputEncoding( String inputEncoding )
{
this.inputEncoding = inputEncoding;
}
/**
*
Getter for the field outputEncoding.
*
* @return the outputEncoding
* @since 1.1
*/
public String getOutputEncoding()
{
return outputEncoding;
}
/**
*
Doxia is a content generation framework that provides powerful techniques for generating static and dynamic content, supporting a variety of markup languages.
All options provided by Sun on the Javadoc homepages are wrapped in the Maven Javadoc Plugin. This
plugin supports Javadoc 1.4, 1.5 and 6.0 options. Refer you to the
Javadoc Package Summary
for more information.
Where in the pom.xml do I configure the Javadoc Plugin?
Like all other site report plugins, the Javadoc Plugin goes in the <reporting/> section
of your pom.xml. In this case, you will need to call mvn site to run reports.
You could also configure it in the <plugins/> or <pluginsManagement/> in <build/> tag
of your pom.xml. In this case, you will need to call mvn javadoc:javadoc to run the main
report.
Where do I put Javadoc resources like HTML files or images?
All javadoc resources like HTML files, images could be put in the
${basedir}/src/main/javadoc directory.
The Javadoc Plugin calls the Javadoc tool with
argument files,
i.e. files called 'options', 'packages' and 'argfile' (or 'files' with Jdk < 1.4):
${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
@options \
@packages | @argfile
These argument files are generated at runtime depending the Javadoc Plugin configuration and are deleted
when the Javadoc Plugin ended.
To preserve them, just add <debug>true</debug> in your Javadoc Plugin configuration or just call
mvn javadoc:javadoc -Ddebug=true or mvn javadoc:javadoc -X.
In this case, an additional script file (javadoc.bat (or .sh) will be created in the apidocs
directory.
How to add additional Javadoc parameters?
You could need to add more Javadoc parameters to be process by the Javadoc Tool (i.e. for doclet).
For this, you should use the <additionalparam/> parameter in your Javadoc Plugin configuration.
How to add additional Javadoc options?
You could need to add more J options (i.e. runtime system java options that runs Javadoc tool like -J-Xss)
to be process by the Javadoc Tool. For this, you should use the <additionalJOption/> parameter
in your Javadoc Plugin configuration.
The Javadoc Plugin calls the Javadoc tool with J options, i.e.:
${project.reporting.outputDirectory}/apidocs/javadoc.exe(or .sh) \
-J-Xss128m \
@options \
@packages | @argfile
How to increase Javadoc heap size?
If you need to increase the Javadoc heap size, you should use the <minmemory/> and
<maxmemory/> parameters in your Javadoc Plugin configuration. For instance:
...
org.apache.maven.pluginsmaven-javadoc-plugin
...
128m1g
...
...
...
Note: The memory unit depends on the JVM used. The units supported could be: k,
kb, m, mb, g, gb, t,
tb. If no unit specified, the default unit is m.
How to add proxy support?
To specify a proxy in the Javadoc tool, you need to configure an active proxy in your settings.xml. Read the
Configuring a proxy guide for more information.
Just set the <quiet/> parameter to true in your Javadoc Plugin configuration.
How to remove test Javadocs report?
You need to configure the <reportSets/> parameter. Read the
Selective Javadocs Reports part for more information.
How to deploy Javadoc jar file?
Basically, you need to call mvn clean javadoc:jar deploy. If you want to include the javadoc jar
in a release process, you need to attach it in the release profile, for instance:
...
releaseorg.apache.maven.pluginsmaven-javadoc-pluginattach-javadocsjar
...
...
To deploy the Javadoc jar on a given Maven repository, you could call:
mvn deploy:deploy-file \
-DgroupId=<group-id> \
-DartifactId=<artifact-id> \
-Dversion=<version> \
-Dfile=<path-to-file> \
-Dpackaging=jar \
-DrepositoryId=<repository-id> \
-Durl=dav:http://www.myrepository.com/m2 \
-Dclassifier=javadoc
How to include additional source code directories in aggregate mode?
If you use the Javadoc report in the aggregate mode, i.e. using the aggregate parameter, and if the
Javadoc report does not include additional source code directories defined using the
build-helper:add-source goal,
you need to use the javadoc:aggregate goal instead of javadoc:javadoc goal. Read the
Aggregating Javadocs for Multi-Projects part for more information.
How to use links option in Standard Doclet?
You need to configure the <links/> parameter. Also, you need to correctly write references in
your Javadoc, i.e.:
@see MyMojo or {@link MyMojo} will NOT work.
@see com.mycompany.plugin.myplugin.MyMojo or {@link com.mycompany.myplugin.MyMojo} will work.
On Windows with Sun JDK, why javadoc:javadoc goal blows up due to an IllegalArgumentException in sun.net.www.ParseUtil.decode()?
You are on Windows XP with Sun JDK 5 or JDK 6 freshly installed, and when you run mvn javadoc:javadoc,
you are stick by an sun.net.www.ParseUtil.decode() exception like this
one.
...
[INFO] ------------------------------------------------------------------------
[ERROR] BUILD ERROR
[INFO] ------------------------------------------------------------------------
[INFO] An error has occurred in JavaDocs report generation:Exit code: 1 - java.lang.IllegalArgumentException
at sun.net.www.ParseUtil.decode(ParseUtil.java:189)
at sun.misc.URLClassPath$FileLoader.<init>(URLClassPath.java:953)
at sun.misc.URLClassPath$3.run(URLClassPath.java:326)
at java.security.AccessController.doPrivileged(Native Method)
at sun.misc.URLClassPath.getLoader(URLClassPath.java:320)
at sun.misc.URLClassPath.getLoader(URLClassPath.java:297)
at sun.misc.URLClassPath.findResource(URLClassPath.java:144)
at java.net.URLClassLoader$2.run(URLClassLoader.java:362)
at java.security.AccessController.doPrivileged(Native Method)
at java.net.URLClassLoader.findResource(URLClassLoader.java:359)
at java.lang.ClassLoader.getResource(ClassLoader.java:977)
at java.lang.ClassLoader.getResourceAsStream(ClassLoader.java:1159)
at javax.xml.parsers.SecuritySupport$4.run(SecuritySupport.java:96)
at java.security.AccessController.doPrivileged(Native Method)
at javax.xml.parsers.SecuritySupport.getResourceAsStream(SecuritySupport.java:89)
at javax.xml.parsers.FactoryFinder.findJarServiceProvider(FactoryFinder.java:250)
at javax.xml.parsers.FactoryFinder.find(FactoryFinder.java:223)
at javax.xml.parsers.SAXParserFactory.newInstance(SAXParserFactory.java:128)
at com.sun.tools.doclets.internal.toolkit.builders.LayoutParser.parseXML(LayoutParser.java:72)
at com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder.build(ClassBuilder.java:108)
at com.sun.tools.doclets.formats.html.HtmlDoclet.generateClassFiles(HtmlDoclet.java:155)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateClassFiles(AbstractDoclet.java:164)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:106)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
com.sun.tools.doclets.internal.toolkit.util.DocletAbortException
at com.sun.tools.doclets.internal.toolkit.builders.LayoutParser.parseXML(LayoutParser.java:79)
at com.sun.tools.doclets.internal.toolkit.builders.ClassBuilder.build(ClassBuilder.java:108)
at com.sun.tools.doclets.formats.html.HtmlDoclet.generateClassFiles(HtmlDoclet.java:155)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateClassFiles(AbstractDoclet.java:164)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:106)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
com.sun.tools.doclets.internal.toolkit.util.DocletAbortException
at com.sun.tools.doclets.formats.html.HtmlDoclet.generateClassFiles(HtmlDoclet.java:159)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.generateClassFiles(AbstractDoclet.java:164)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:106)
at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25)
at java.lang.reflect.Method.invoke(Method.java:597)
at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:215)
at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:91)
at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
at com.sun.tools.javadoc.Start.begin(Start.java:128)
at com.sun.tools.javadoc.Main.execute(Main.java:41)
at com.sun.tools.javadoc.Main.main(Main.java:31)
Command line was:C:\Java\jdk1.6.0_03\jre\..\bin\javadoc.exe @options @packages
...
Your CLASSPATH environement variable is probably corrupted, i.e. something like:
CLASSPATH=.;C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip;%JAVAHOME%
with %JAVAHOME% not a valid environment variable.
To resolve it, just reset the CLASSPATH environement variable, i.e.: set CLASSPATH=
or set a new CLASSPATH environement variable, i.e.:
set CLASSPATH=C:\Java\jdk1.6.0_03\jre\lib\ext\QTJava.zip
or fix the wrong environment variable.
How to hide developer/contributor email addresses?
You could use services such as reCAPTCHA Mailhide.
In this case, just replace email by the given URL, for instance:
...
foohttp://mailhide.recaptcha.net/d?k=01ebFB9eM2hZL-T96IpUgRmA==&c=AI-pouLFNTr5xMTBVDaj8iKeIFI5dy9Wj5cxSY0Nuhw=
...
...
...
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-ejb-plugin/ 0000755 0001750 0001750 00000000000 11632765551 024466 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-ejb-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025244 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-ejb-plugin/fml/faq.fml 0000644 0001750 0001750 00000003673 11055554323 026514 0 ustar twerner twerner
How can I specify a Class-Path: entry in the manifest of an EJB jar?
You just have to configure it:
...
org.apache.maven.pluginsmaven-ejb-plugin
...
true
...
...
How does the classifier affect artifacts in my EJB project?
When used, the copy of the artifact in your project will have the classifier appended to its
filename. This can be used to differentiate duplicate artifacts.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-antrun-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025235 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-antrun-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026013 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-antrun-plugin/fml/faq.fml 0000644 0001750 0001750 00000002734 11055554323 027260 0 ustar twerner twerner
Why use antrun and not the Ant program itself?
Maven has certain benefits over Ant. And for your Ant projects to take
advantage of these, you can use Maven as your project management tool and
use its maven-antrun-plugin to build your Ant projects.
Furthermore, if you wish to migrate from Ant to Maven, you can use
this plugin first, then gradually convert your Ant expressions into their
corresponding Maven expressions.
Resources are non-source code files used by your project. Examples of
these are properties files, images and XML files.
When should I use the Resources Plugin's goal outside a lifecycle?
The Maven Resource Plugin simply copies resources from your source to
your build output (with optional filtering). So if that's the only
operation you are interested in, you can skip the other phases such as
compilation and testing and simply do
mvn resources:resources
For example, if you just debugged your configuration file and you
want to manually test it in your container if it works, you can simply
do
mvn resources:resources
This will produce those configuration files on your
output thus skipping the other phases which may eat up a huge amount of
your time.
Do my main resources go to my test resources as well?
No. Your main resources and your test resources are separated from
each other.
Your test resources should only be used by your tests. Thus, they are
separated from the main to avoid any side effects that may occur.
What encoding values are allowed?
The Maven Resource Plugin only allows encoding values representing
the charsets supported by the Java platform, namely US-ASCII,
ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE and UTF-16.
How does the classifier affect artifacts in my war project?
When used, the copy of the artifact in your project will have the classifier appended to its
filename. This can be used to differentiate duplicate artifacts.
How do I exclude transitive dependencies from my project?
Give it a "provided" scope.
What's the difference between using dependentWarExclude and provided scope?
dependentWarExclude is used in war overlays for excluding dependent
war files from being included in the exploded war.
How do I exclude files in my web resources?
Use the webResourcesexclude parameter to identify the tokens to use for the filtering.
How do I exclude files when doing war overlays?
Use the dependentWarExcludes parameter to identify the tokens to use for the filtering.
Where can I find the documentation for the plugin's configuration?
For each goal, you can use the documentation from the plugin site.
If you need a specific version, generate it using mvn site:site or use:
]]>
How do I create a jar containing the classes in my webapp?
If you would simply like to package the classes and resources as a jar in WEB-INF/lib
rather than as loose files under WEB-INF/classes, use the following configuration:
maven-war-pluginX.Ytrue
]]>
If you need to re-use this jar in another project, the recommended approach is to move the classes to a
separate module that builds a jar, and then declare a dependency on that jar from your webapp as well as from
any other projects that need it.
If you can't move the classes to another project, you can deploy the classes and resources included in
your webapp as an "attached" artifact, with a classifier, by using the following configuration:
Maven is a software project management and comprehension tool. Based on the concept of a project object model
(POM), Maven can manage a project's build, reporting and documentation from a central piece of information.
This site is separated into the following sections, depending on how you'd like to use Maven:
Run Maven
Information for those needing to build a project that uses Maven
Use Maven
Information for those wanting to use Maven to build their project, including a "10 minute test" that gives a
practical overview of Maven's main features in just 10 minutes
Write Maven Plugins
Information for those who may or may not be using Maven, but want to provide a plugin for shared
functionality or to accompany their own product or toolset
Improve the Maven Repository
Information for those who may or may not use, but are interested in getting project metadata into the
repository
Develop Maven
Information for those who are currently developers, or who are interested
in contributing to the Maven project itself
Each guide is divided into a number of trails to get you started on a particular topic, and includes a
reference area and a "cookbook" of common examples.
You can access the guides at any time from the left navigation.
For detailed information on just some of the plugins available for Maven, see the
plugin list.
How to Get Support
Support for Maven is available in a variety of different forms.
To get started, search the documentation, the wiki,
issue tracker, or the mailing list archives to
see if the problem has been solved or reported before.
If the problem has not been reported before, the recommended way to get help is to
subscribe to the Maven Users Mailing list. Many other users and Maven developers
will answer your questions there, and the answer will be archived for others in the future.
Maven is an open source community and welcomes contributions. If you'd like to get involved, see the
Guide to helping with Maven.
Maven is a part of the Apache Software Foundation. We'd like to thank
the sponsors that provide financial assistance to the foundation. For more information on how you can support the
foundation, see the sponsorship page.
To commit changes to the repository, execute the following command to commit your changes (svn will
prompt you for your password):
$ svn commit --username your-username -m "A message"
For those users who are stuck behind a corporate firewall which is blocking HTTP access to the Subversion
repository, you can try to access it via the developer connection:
The Subversion client can go through a proxy, if you configure it to do so. First, edit your servers
configuration file to indicate which proxy to use. The file's location depends on your operating system. On
Linux or Unix it is located in the directory ~/.subversion. On Windows it is in %APPDATA%\Subversion
(try echo %APPDATA%, note this is a hidden directory).
There are comments in the file explaining what to do. If you don't have that file, get the latest Subversion
client and run any command; this will cause the configuration directory and template files to be created.
Example: Edit the servers file and add something like:
Starting with Maven, plugins can be written in Java or any of a
number of scripting languages. Plugins consists of one or more Mojos,
each one being the implementation for one of the plugin's goals.
Maven tries to stay out of
the way of the programmer with its new Mojo API. This opens up the
opportunity for many Mojos to be reused outside of Maven, or bridged
into Maven from external systems like Ant.
NOTE: For now, we will limit the discussion to Java-based Mojos, since
each scripting language will present these same basic requirements with
various forms of implementation.
Although the requirements on Mojos are minimal by design, there are
still a very few requirements that Mojo developers must keep in mind. Basically, these Mojo requirements are embodied by the
org.apache.maven.plugin.Mojo
interface, which the Mojo
must implement (or else extend its abstract base class counterpart
org.apache.maven.plugin.AbstractMojo
). This interface
guarantees the correct execution contract for the Mojo: no parameters,
void return type, and a throws clause that allows only
org.apache.maven.plugin.MojoExecutionException
and its
derivatives. It also guarantees that the Mojo will have access to the
standard Maven user-feedback mechanism,
org.apache.maven.monitor.logging.Log
, so the Mojo can
communicate important events to the console or other log sink.
As mentioned before, each Plugin - or packaged set of Mojos - must
provide a descriptor called
plugin.xml
under the path
META-INF/maven
inside the Plugin jar file. Fortunately,
Maven also provides a set of Javadoc annotations and tools to generate
this descriptor, so developers don't have to worry about directly
authoring or maintaining a separate XML metadata file.
To serve as a quick reference for the developer, the rest of this page
will document these features (the API, along with the annotations)
which are considered the best practice for developing Mojos.
This interface forms the contract required for Mojos to interact
with the Maven infrastructure. It features an
execute()
method, which triggers the Mojo's build-process behavior, and can
throw a
MojoExecutionException
if an error condition
occurs. See below for a discussion on proper use of this
Exception
class. Also included is the
setLog(..)
method, which simply allows Maven to inject a
logging mechanism which will allow the Mojo to communicate to the
outside world through standard Maven channels.
Perform whatever build-process behavior this Mojo implements.
This is the main trigger for the Mojo inside the Maven system,
and allows the Mojo to communicate fatal errors by throwing an
instance of MojoExecutionException.
The
MojoExecutionException (and all error
conditions inside the Mojo) should be handled very carefully.
The simple wrapping of lower-level exceptions without providing
any indication of a user-friendly probable cause is strictly
discouraged. In fact, a much better course of action is to
provide error handling code (try/catch stanzas) for each
coherent step within the Mojo's execution. Developers are then
in a much better position to diagnose the cause of any error,
and provide user-friendly feedback in the message of the
MojoExecutionException.
Currently, this abstract base class simply takes care of managing
the Maven log for concrete derivations. In keeping with this, it
provides a
protected
method,
getLog():Log
,
to furnish Log access to these concrete implementations.
Method Summary:
public void setLog( org.apache.maven.monitor.logging.Log )
[IMPLEMENTED]
Inject a standard Maven logging mechanism to allow this Mojo
to communicate events and feedback to the user.
protected Log getLog()
[IMPLEMENTED]
Furnish access to the standard Maven logging mechanism which
is managed in this base class.
Perform whatever build-process behavior this Mojo implements.
See the documentation for
Mojo
above for more
information.
This interface supplies the API for providing feedback to the user
from the Mojo, using standard Maven channels. There should be no big
surprises here, although you may notice that the methods accept
java.lang.CharSequence
rather than
java.lang.String
. This is provided mainly as a
convenience, to enable developers to pass things like
StringBuffer
directly into the logger, rather than
formatting first by calling
toString()
.
Method Summary:
void debug( java.lang.CharSequence )
Send a message to the user in the
debug
error level.
Send a message (and accompanying exception) to the user in the
debug
error level. The error's stacktrace will be output
when this error level is enabled.
void debug( java.lang.Throwable )
Send an exception to the user in the
debug
error level.
The stack trace for this exception will be output when this
error level is enabled.
void info( java.lang.CharSequence )
Send a message to the user in the
info
error level.
Send a message (and accompanying exception) to the user in the
info
error level. The error's stacktrace will be output
when this error level is enabled.
void info( java.lang.CharSequence )
Send an exception to the user in the
info
error level.
The stack trace for this exception will be output when this
error level is enabled.
void warn( java.lang.CharSequence )
Send a message to the user in the
warn
error level.
Send a message (and accompanying exception) to the user in the
warn
error level. The error's stacktrace will be output
when this error level is enabled.
void warn( java.lang.CharSequence )
Send an exception to the user in the
warn
error level.
The stack trace for this exception will be output when this
error level is enabled.
void error( java.lang.CharSequence )
Send a message to the user in the
error
error level.
Send a message (and accompanying exception) to the user in the
error
error level. The error's stacktrace will be output
when this error level is enabled.
void error( java.lang.CharSequence )
Send an exception to the user in the
error
error level.
The stack trace for this exception will be output when this
error level is enabled.
In addition to the normal Java requirements in terms of interfaces
and/or abstract base classes which need to be implemented, a plugin
descriptor must accompany these classes inside the plugin jar. This
descriptor file is used to provide metadata about the parameters and
other component requirements for a set of Mojos so that Maven can
initialize the Mojo and validate its configuration before executing
it. As such, the plugin descriptor has a certain set of information
that is required for each Mojo specification to be valid, as well as
requirements for the overall plugin descriptor itself.
NOTE: In the following discussion, bolded items are the descriptor's
element name along with a Javadoc annotation (if applicable) supporting
that piece of the plugin descriptor. A couple of examples are:
someElement
(@annotation parameterName="parameterValue")
or
someOtherElement (@annotation <rawAnnotationValue>)
.
The plugin descriptor must be provided in a jar resource with the
path:
META-INF/maven/plugin.xml
, and it must contain the
following:
Descriptor Element
Required?
Notes
mojos
Yes
Descriptors for each Mojo provided by the plugin, each inside a
mojo
sub-element. Mojo descriptors are covered in detail
below. Obviously, a plugin without any declared Mojos doesn't
make sense, so the
mojos
element is required, along with
at least one
mojo
sub-element.
dependencies
Yes
A set of dependencies which the plugin requires in order to
function. Each dependency is provided inside a
dependency
sub-element. Dependency specifications are covered below. Since
all plugins must have a dependency on
maven-plugin-api
, this element is effectively
required.
Using the plugin toolset, these dependencies can be
extracted from the POM's dependencies.
Each Mojo specified inside a plugin descriptor must provide the
following (annotations specified here are at the class level):
Descriptor Element
Annotation
Required?
Notes
aggregator
@aggregator
No
Flags this Mojo to run it in a multi module way, i.e. aggregate the build with the set of
projects listed as modules.
configurator
@configurator <roleHint>
No
The configurator type to use when injecting parameter values into this Mojo. The value is
normally deduced from the Mojo's implementation language, but can be specified to allow a
custom ComponentConfigurator implementation to be used. NOTE: This will only be used in
very special cases, using a highly controlled vocabulary of possible values. (Elements
like this are why it's a good idea to use the descriptor tools.)
When this goal is invoked, it will first invoke a parallel lifecycle, ending at the given
phase. If a goal is provided instead of a phase, that goal will be executed in isolation.
The execution of either will not affect the current project, but instead make available the
${executedProject} expression if required. An alternate lifecycle can also be
provided: for more information see the documentation on the
build lifecycle.
executionStrategy
@executionStrategy <strategy>
No
Specify the execution strategy. NOTE: Currently supports once-per-session,
always.
goal
@goal <goalName>
Yes
The name for the Mojo that users will reference from the command line to execute the Mojo
directly, or inside a POM in order to provide Mojo-specific configuration.
inheritByDefault
@inheritByDefault <true|false>
No. Default: true
Specify that the Mojo is inherited.
instantiationStrategy
@instantiationStrategy <per-lookup>
No. Default: per-lookup
Specify the instantiation strategy.
phase
@phase <phaseName>
No
Binds this Mojo to a particular phase of the standard build lifecycle, if specified.
NOTE: This is only required if this Mojo is to participate in the standard build
process.
requiresDependencyResolution
@requiresDependencyResolution <requiredScope>
No
Flags this Mojo as requiring the dependencies in the specified scope (or an implied scope)
to be resolved before it can execute. Currently supports compile,
runtime, and test scopes. If this annotation is present but no scope
is specified, the scope defaults to runtime.
requiresDirectInvocation
@requiresDirectInvocation <true|false>
No. Default: false
Flags this Mojo to be invoke directly.
requiresOnline
@requiresOnline <true|false>
No. Default: true
Flags this Mojo to be run in online mode.
requiresProject
@requiresProject <true|false>
No. Default: true
Flags this Mojo to run inside of a project.
requiresReports
@requiresReports <true|false>
No. Default: false
Flags this Mojo to require reports.
description
none (detected)
No
The description of this Mojo's functionality. Using the toolset, this will be the
class-level Javadoc description provided. NOTE: While this is not a required part of the
Mojo specification, it SHOULD be provided to enable future tool support for browsing, etc.
and for clarity.
implementation
none (detected)
Yes
The Mojo's fully-qualified class name (or script path in the case of non-Java Mojos).
language
none (detected)
No. Default: java
The implementation language for this Mojo (Java, beanshell, etc.).
deprecated
@deprecated <deprecated-text>
No
Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated.
This will trigger a warning when a user tries to configure a parameter
marked as deprecated.
since
@since <since-text>
No
Specify the version when the Mojo was added to the API. Similar to Javadoc since.
Each Mojo specifies the parameters that it expects in order to work.
These parameters are the Mojo's link to the outside world, and
will be satisfied through a combination of POM/project values, plugin
configurations (from the POM and configuration defaults), and System
properties.
NOTE[1]: For this discussion on Mojo parameters, a single
annotation may span multiple elements in the descriptor's specification
for that parameter. Duplicate annotation declarations in this section
will be used to detail each parameter of an annotation separately.
NOTE[2]: In many cases, simply annotating a Mojo field with
@parameter
will be enough to allow injection of a value for that
parameter using POM configuration elements. The discussion below
shows advanced usage for this annotation, along with others.
Each parameter for a Mojo must be specified in the
plugin descriptor as follows:
Descriptor Element
Annotation
Required?
Notes
alias
@parameter alias="myAlias"
No
Specifies an alias which can be used to configure this parameter from the POM. This is
primarily useful to improve user-friendliness, where Mojo field names are not intuitive to
the user or are otherwise not conducive to configuration via the POM.
configuration
@component role="..." roleHint="..."
No
Populates the field with an instance of a Plexus component. This is like declaring a
requirement in a Plexus component. The default requirement will have a role equal
to the declared type of the field, and will use the default role hint. You can customise
either of these by providing a role and/or roleHint parameter.
e.g.@component role="org.apache.maven.artifact.ArtifactHandler"
roleHint="ear"Note: This is identical to the deprecated
form of parameter: @parameter
expression="${component.yourpackage.YourComponentClass}".
Specifies the expression used to calculate the value to be injected into this parameter of
the Mojo at buildtime. This is commonly used to refer to specific elements in the POM, such
as ${project.resources}, which refers to the list of resources meant to accompany the
classes in the resulting jar file. The default value is used when the expression evaluates
to null . NOTE: If not specified, an expression of ${<name>}
is assumed, which can only be satisfied from POM configuration or System properties. The
use of '${' and '}' is required to delimit actual expressions which may be evaluated.
editable
@readonly
No
Specifies that this parameter cannot be configured directly by the user (as in the case of
POM-specified configuration). This is useful when you want to force the user to use common
POM elements rather than plugin configurations, as in the case where you want to use the
artifact's final name as a parameter. In this case, you want the user to modify
<build><finalName/></build> rather than specifying
a value for finalName directly in the plugin configuration section. It is also useful to
ensure that - for example - a List-typed parameter which expects items of type Artifact
doesn't get a List full of Strings. NOTE: Specification of this annotation flags the
parameter as non-editable; there is no true/false value.
required
@required
No
Whether this parameter is required for the Mojo to function. This is used to validate the
configuration for a Mojo before it is injected, and before the Mojo is executed from some
half-state. NOTE: Specification of this annotation flags the parameter as required; there
is no true/false value.
description
none (detected)
No
The description of this parameter's use inside the Mojo. Using the toolset, this is
detected as the Javadoc description for the field. NOTE: While this is not a required part
of the parameter specification, it SHOULD be provided to enable future tool support for
browsing, etc. and for clarity.
name
none (detected)
Yes
The name of the parameter, to be used in configuring this parameter from the Mojo's
declared defaults (discussed below) or from the POM. Using the toolset, this is detected
as the Java field name.
type
none (detected)
Yes
The Java type for this parameter. This is used to validate the result of any expressions
used to calculate the value which should be injected into the Mojo for this parameter.
Using the toolset, this is detected as the class of the Java field corresponding to
this parameter.
deprecated
@deprecated <deprecated-text>
No
Specify the version when the Mojo was deprecated to the API. Similar to Javadoc deprecated.
This will trigger a warning when a user tries to configure a parameter
marked as deprecated.
since
@since <since-text>
No
Specify the version when the Mojo was added to the API. Similar to Javadoc since.
The final component of a plugin descriptor is the dependencies. This
enables the plugin to function independently of its POM (or at least
to declare the libraries it needs to run). Dependencies are taken from
the
runtime
scope of the plugin's calculated dependencies (from
the POM). Dependencies are specified in exactly the same manner as in
the POM, except for the <scope> element (all dependencies in the
plugin descriptor are assumed to be runtime, because this is a
runtime profile for the plugin).
By now, we've mentioned the plugin tools several times without telling
you what they are or how to use them. Instead of manually writing (and
maintaining) the metadata detailed above, Maven ships with some
tools to aid in this task. In fact, the only thing a plugin developer
needs to do is declare his project to be a plugin from within the POM.
Once this is done, Maven will call the appropriate descriptor
generators, etc. to produce an artifact that is ready for use within
Maven builds. Optional metadata can be injected via Javadoc annotation
(and possibly JDK5 annotations in the future) as described above,
enabling richer interactions between the Mojo and the user. The
section below describes the changes to the POM which are necessary to
create plugin artifacts.
From the POM, Maven plugin projects look quite similar to any other
project. For pure Java plugins, the differences are even smaller than
for script-based plugins. The following details the POM elements
which are necessary to build a Maven plugin artifact.
POM Element
Required for Java Mojos?
Sample Declaration
Notes
packaging
Yes
<packaging>
maven-plugin
</packaging>
The POM must declare a packaging element which describes this
project as a Maven plugin project.
In the case of script-based Mojos (which are not covered in
detail within this document), the POM must include an additional
element to distinguish script sources from (optional) Java
supporting classes. This element is scriptSourceDirectory,
inside the build section. This directory is included in the list
of resources which accompany any compiled code in the resulting
artifact. It is specified separately from the resources in the
build section to denote its special status as an alternate source
directory for scripts.
After making the changes above, the developer can simply call
mvn install
to install the plugin to
the local repository. (Any of the other standard lifecycle targets like
package, deploy, etc. are also available in like fashion.)
If you're using JetBrains IntelliJ IDEA to develop your plugin,
you can use the following to configure the javadoc annotations as live
templates.
Download this file,
and place it in $USER_HOME/.IntelliJIdea/config/templates
(re)startup IntelliJ IDEA (templates are loaded on startup)
add the following list to Settings -> IDE -> Errors -> General
-> Unknown javadoc tags -> Additional javadoc tags
If you're interested in testing your Maven skills, check out JavaBlackBelt's Maven exam.
This exam is being written collaboratively by the community. Feel free to add new questions, suggest improvements, etc.
If you are writing an article on Maven we suggest contacting the developers on the mailing list as we would be happy
to provide feedback to help ensure accuracy in your article. Just ping us on the dev mailing list
to get in touch.
This page lists some of the most pressing documentation needs. If you feel something is missing, please be sure
to let us know at the
Maven Users Mailing List.
Documentation for users
new SNAPSHOT handling -
partially done on Brett's blog
guide to dependencies, including:
dependency scoping - especially system scope
version range specifications
conflict resolution
deployment mechanism
dependency management
plugin management -
in progress by J Matthew Pryor and John Casey
plugin configuration
plugin downloading -
partial on Brett's blogs
report generation
project inheritence and company wide strategy
plugin documentation
using POM-properties in conjunction with plugin configuration to abstract child-POM configs
archetypes - writing and using
plugin usage guide/summary for core plugins - esp. release plugin
strategy for migrating from Ant builds
strategy for migrating from Maven 1.x builds - esp. plugins that don't convert directly
Documentation for plugin authors
Beanshell examples
plugin writing guide
report writing guide
site customisation guide
common tips and tricks for accessing project/build data
guide to available parameter expressions
list of standards for submitting new plugins (minimum documentation, test coverage?)
Documentation for Maven developers
Lifecycle architecture
High level architecture, components explanation
Intro to Plexus
contributors guide (add to current and consolidate, walk through some first steps)
Additional Notes
Brett Porter wrote:
> The active project changes during the reactor build. At the compile
> stage, it refers to the target/classes directory. At the package
> stage, it points to the jar file. If you are implementing your own
> packaging goal, you need to call project.getArtifact().setFile( ... )
> to ensure this is used.
- multi module howto
- per user scm setup
- outline behaviour when connection and developConnection are defined
Our current URL looks like:
scm:cvs:pserver:@cvs.host.name:/cvsroot:module-version
Using this URL, the default is to connect to the CVS server using the
same userid as the current user. This is the desired behavior and I
don't want to mess that up. I just would like a means to add a userid
in the URL only in special circumstances like Continuum.
We might want to do something where we say it is a best practice to
specify a ${user} and take it from the environment and allow an override.
- testing a plugin
- How to get started behind an NTLM proxy.
- How snapshots works
- How do i use the lifecycle provided by a plugin:
- How do i disable ibiblio
- using version ranges
- plugin expressions (look at bob allison's work)
- overriding the central repository (use central)
- description of what packagings are available and how they work
- creating upload bundles
- modello example
- changing the snapshot policy frequency
- overriding central repo
- using POM info in applications: the POM is packaged so there is acccess
continuum example to get the version.
- quick description of scm,wagon,continuum
Profiles Example
env-testenvtesttest.propertiesenv-productionenvproductionapp.properties
and you can run mvn with one of profiles like:
mvn -P env-production clean:clean install ==> we use the profile id
or
mvn -Denv=test clean:clean install ==> we use the property env define in
Emmanuel
martin.kuhn@merkur.at wrote:
> Hi,
>
> I'm a maven newbie and I try out maven 2.0 alpha 3.
>
> My questions:
>
> I have a project to build / deploy for three different enviroments (test,
> integration, production).
>
> The difference beetween the bundles is only a properties file (there are
> three different files: config-test.properties,
> config-integration.properties ...).
> In the build process I want to copy the right config file to a file with a
> common name (config.properties -> the app should work with this config
> file)
>
> Is there a solution to handle this with maven 2 or do I have to write a
> plugin?
>
]]>
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-site/fml/ 0000755 0001750 0001750 00000000000 11632765552 024155 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-site/fml/general.fml 0000644 0001750 0001750 00000032245 11121212244 026252 0 ustar twerner twerner
How do I prevent including JARs in WEB-INF/lib? I need a "compile only" scope!
The scope you should use for this is
provided. This indicates to Maven that the dependency will be
provided at run time by its container or the JDK, for example.
Dependencies with this scope will not be passed on transitively, nor will they be bundled in an package such
as a WAR, or included in the runtime classpath.
How do I list available plugins?
The "Available Plugins" page lists them,
and provides additional information to browse the Maven 2 repository.
See http://maven.apache.org/plugins
How do I determine what version of a plugin I am using?
You can use the Maven Help Plugin's describe goal. For example, to find out the version
of the install plugin:
mvn -Dplugin=install help:describe
Note that you must give the plugin prefix as the argument to plugin, not it's artifact ID.
Maven can't seem to download the dependencies. Is my installation correct?
You most probably need to configure Maven to use a proxy. Please see the information on
Configuring a proxy for information on how to configure your proxy
for Maven.
I have a jar that I want to put into my local repository. How can I copy it in?
If you understand the layout of the maven repository, you can copy the jar directly into where it
is meant to go. Maven will find this file next time it is run.
If you are not confident about the layout of the maven repository, then you can
adapt the following command to load in your jar file, all on one line.
-DgroupId=
-DartifactId=
-Dversion=
-Dpackaging=
-DgeneratePom=true
Where: the path to the file to load
the group that the file should be registered under
the artifact name for the file
the version of the file
the packaging of the file e.g. jar
]]>
This should load in the file into the maven repository, renaming it as needed.
How do I unsubscribe from Maven mailing lists?
To unsubscribe from a Maven mailing list you simply send a message to
[mailing-list]-unsubscribe@maven.apache.org
So, if you have subscribed to users@maven.apache.org then you would
send a message to users-unsubscribe@maven.apache.org in order to
get off the list.
People tend to have problems when they subscribe with one address and
attempt to unsubscribe with another. So make sure that you are using the
same address when unsubscribing that you used to subscribe before
asking for help.
If you find you still cannot get off a list then
send a message to [mailing-list]-help@maven.apache.org. These
instructions are also appended to every message sent out on a maven mailing
list ...
How do I skip the tests?
Add the parameter -Dmaven.test.skip=true in the command line
How can I run a single unit test?
Use the parameter -Dtest=MyTest at the command line.
NB: do not specify the entire package (org.apache.x.y.MyTest)
Handle special characters in site
Configure your ide to use the correct encoding. With eclipse, add
-Dfile.encoding=ISO-8859-1 in eclipse.ini file
Configure the output encoding in your pom
...
org.apache.maven.pluginsmaven-site-plugin2.0-beta-6UTF-8
...
Configure the file encoding use by mvn.
add to MAVEN_OPTS the encoding (same as the ide).
This can be made with adding MAVEN_OPTS="-Dfile.encoding=ISO-8859-1" in $HOME/.profile
How do I include tools.jar in my dependencies?
The following code includes tools.jar for JDKs on Windows, Linux and Solaris (it is already
included in the runtime for Mac OS X and some free JDKs).
...
default-tools.jarjava.vendorSun Microsystems Inc.com.suntools1.4.2system${java.home}/../lib/tools.jar
...Maven compiles my test classes but doesn't run them?
Tests are run by the surefire plugin. The surefire plugin can be configured to run certain test classes and
you may have unintentionally done so by specifying a value to ${test}.
Check your settings.xml and pom.xml for a property named "test" which would like this:
...
testsome-value
...
or
...
some-value
...Where are Maven SNAPSHOT artifacts?
If you are trying to build a development version of Maven or plugins,
you may need to access the maven snapshot repositories.
The Maven XSD is located here and the Maven
Settings XSD is located here.
Your favorite IDE probably supports XSD schema's for pom.xml and settings.xml editing. You need to
specify the following:
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/maven-v4_0_0.xsd">
...
</project>
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
http://maven.apache.org/xsd/settings-1.0.0.xsd">
...
</settings>
Maven doesn't work, how do I get help?
We have compiled a list of available resources on the
getting help page
How to produce execution debug output or error messages?
You could call Maven with -X parameter or -e parameter. For more information,
run:
mvn --help
What is a Mojo?
A mojo is a Maven plain Old Java Object. Each mojo is an executable
goal in Maven, and a plugin is a distribution of one or more related mojos.
Maven 2.0 will feel very different to a Maven 1.0 user - and perhaps a little strange. But it is a lot simpler
to work with and closer to how Maven was always meant to be! The key changes from Maven 1.0 are:
Faster and smaller
- The Maven core no longer uses Ant, Jelly or Xerces making it much smaller, has
fewer dependencies, and is perfect for embedding in other tools.
Defined build lifecycle
- No more
prereqs
,
preGoals
and
postGoals
.
The build is a series of well defined phases. This also means that the normal goal names are not used -
compile
,
test
and
install
work for any project type.
Built-in multiple project handling
- Use the same goals on a set of projects, and aggregate the
results.
Improved
SNAPSHOT
handling
- Snapshots are now checked for updates only once per day by
default - though can be configured to be once per build, on a particular interval, or never. A command line
option can force a check - making it more like updating from an SCM.
No more properties files
- All plugins are now configured from the POM (which is now called
pom.xml
).
No more
maven.xml
- Plugins are now easier to build and integrate, and are the only way
to script your builds. (Note that additions may later be made to the POM to allow simple things that
scripting
was used for, such as goal aliasing).
No more Jelly
- Plugins are primarily written in Java, though there are providers for other scripting languages.
Improved repository layout
- Maven 2.0 supports both the existing layout, and an improved repository
layout that has deeper, partitioned structure making it easier to browse.
Should I use Maven 2.0, or Maven 1.0?
Maven 2.0 is the latest stable release, and we certainly recommend it for all new projects.
If you are already using Maven 1.0 - you should try out Maven 2.0, as it is very much improved.
However, we still continue to support the Maven 1.x releases at this time.
If you do use Maven 1.0, and would like to upgrade in the future, you should carefully consider following some
of the
Best Practices
listed. These will make your project a lot easier to migrate in the future.
The following are the known limitations in the current Maven 2.0 release compared to Maven 1.x:
Availability of plugins
- While most of the core Maven 1.x plugins have been converted,
several 3rd party plugins may not be available. Maven 2.0 cannot execute Maven 1.0 plugins.
What will happen to Maven 1.0?
Support for Maven 1.0.2 has been discontinued with the release of Maven 1.1.
While significant new features will not be added to the
Maven 1.x core
(such as transitive dependencies), bugfixes and support continue and the
repository is still available.
Will my Maven 1.0 plugins be supported?
Not directly.
We recommend building your Jelly plugins as thin wrappers around Java beans that do not use Maven 1.0 API's,
which will allow easy migration to Maven 2.0.
How do I write custom scripts without a
maven.xml
file?
Everything in m2 is a plugin so for doing any sort of custom work like
that you will need to make a plugin. This 1) greatly reduces the
complexity within m2 because we only deal with proper plugins. The
maven.xml file in m1 was a psuedo plugin essentially and greatly
complicated the internals and 2) it promotes the sharing of your work
right from the get go. To start with you'll probably write a plugin that
is only applicable to your specific requirements, or your team's work,
but you'll see people asking for some functionality and you'll go "hey,
I have something like that!" and hopefully people who have concrete
solutions will generalize their solutions so they can be shared with
others. That's what we're trying to encourage.
We estimate that there's a lot of work bound up in project's maven.xml
that is not being shared and we'd like to try and change that. We plan
to make it dead simple to share plugins and hopefully people can use
other project's plugins as a start for a plugin that they may need
themselves.
How do I convert from Maven 1.x to Maven 2.x?
This is dicussed in Guide to Moving from Maven 1.x to Maven 2.x.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-site/fml/about.fml 0000644 0001750 0001750 00000012333 10744437107 025764 0 ustar twerner twerner
Tell me about the goals of Maven 2.0
In addition to understanding the
Goals of Maven
there have also been questions about why Maven 2.0 is rewritten from the successful Maven 1.0.
In summary, the main goals of the new Maven 2.0 architecture are:
To be simple to use - it should be more obvious and consistent about how things are working
Fast - a new architecture and smaller memory footprint make it as fast as possible
To be able to implement the features demanded were not possible under the Maven 1.0 architecture
Unfortunately, to reach these goals we've had to sacrifice backwards compatibility. Instead of
making many small incremental changes that would break compatibility often over time, we decided to build on a
new, solid base that can be reliable for the future, and also to maintain the existing Maven 1.x product to
ensure that existing users are not left out in the cold.
Can I get involved?
The Maven project welcomes anyone that wishes to contribute to do so by providing patches to the source code,
participating in design discussions, or to help out on the users mailing list by answering questions.
Frequent contributors recognised by existing committers to the project may be asked if they would like to
join the project.
For instructions on checking out and building Maven 2.0, see
Building Maven 2.0
.
What plugin languages will Maven 2.0 support? What about [insert language here]?
As of the current release, Maven supports pure Java and Beanshell. Java is the preferred
language for it's familiarity and speed.
We get asked a lot whether Maven 2.0 will support other languages, in particular Groovy.
We will allow the use of Groovy - and virtually any other scripting
language (if there is demand) if someone can commit a small amount of time to implementing a
factory for it.
We would recommend waiting for Groovy to have a 1.0 release so the API
(and language!) is stable. What we will not be doing is actively
supporting it (in terms of answering questions about how to use it)
like we currently do for Jelly in Maven 1.x.
Beanshell is more mature, and we want a language that users will find
answers for when they look, and that when they find bugs, it is
clearly defined where they actually are.
We may consider emphasising a different language if there are compelling technical reasons
for doing so - if you have a suggestion, feel free to contact the development list.
Where do I get help with Maven 2.0?
Help for both Maven 1.0 and Maven 2.0 can be obtained by subscribing and posting to the
Maven Users List.
You can also join us on IRC (Internet Relay Chat) at irc.codehaus.org
on #maven. This is available both
over IRC
and HTTP
for those behind firewalls (enter #maven in the Channel box).
You could also browse the IRC logs here.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-site/fml/project-faq.fml 0000644 0001750 0001750 00000012640 10767721741 027073 0 ustar twerner twerner
Why do I care?
If you're a user of Maven then you are familiar with the Project Object Model (POM) which is the basic unit of
work in Maven. Maven is a project-centric tool and so we attempt to capture the essence of a project in the
POM. This includes things like what your project is, where the project lives, where you can find the sources
for project, who the developers are on the project and how you can get hold of them, what you need to build
the project, the way your project will be built, what form your project will be distributed in, and where it
will be distributed from.
But why would a project not using Maven care?
Whether you want to use Maven or not, users of your project - especially if you provide a framework or
reusable library - may choose to use Maven. The quality of the metadata in the Maven repository is important
to your users as they list dependencies on your metadata, and link in the information into their own
projects.
Maintaining the metadata for your project is not hard - you can submit it to Maven at release time (and
for large projects it can be setup automatically), and just need to describe your project, its location,
version and most importantly dependencies. Not doing so, or providing incomplete or invalid information
leaves this responsibility to the users of your project.
The Maven team does work on this metadata actively to improve its quality, but with thousands of artifacts in
the repository and only a certain level of knowledge of other projects this is not ideal. Nobody knows your
project better than you.
How do I make sure my project's dependency metadata is correct?
It is best to get it right at the time of a release to avoid having to make difficult updates later on.
Your information can be submitted to Maven using the regular
repository upload procedure
.
The following information is what is best to provide:
Project name
Project URL
License
Description of the project
Group and Artifact ID
Packaging
Version
Dependencies
The group ID should resemble the package name, or reverse DNS of your web site, and can contain subgroups as
you see fit: for example, org.apache.maven and org.apache.maven.plugins.
The artifact ID is specific to each artifact and by convention should be the filename, excluding
extension.
The packaging is the type of your artifact, such as jar, war, ear, ejb, dll, etc.
Each dependency also contains their group ID and artifact ID, as well as version specification.
In particular, you should ensure that optional dependencies are marked as such, and that runtime and testing
only dependencies are marked with the given scope. Ranges can be used for version if that is appropriate,
such as commons-collections [2.0,3.0). Ensure that the dependency exists in the Maven system and matches
first.
How do I ensure my latest releases automatically appear in the Maven repository?
If you able to publish your releases to a Maven2 style repository and make it available over rsync,
we can automatically publish them to ibiblio when released. This procedure requires that you take full
responsibility for your metadata, but also ensures the best service for your users. If this is interesting
to your project, contact dev@maven.apache.org.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-repository-plugin/ 0000755 0001750 0001750 00000000000 11632765551 026145 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-repository-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026723 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-repository-plugin/fml/faq.fml 0000644 0001750 0001750 00000003601 11055554323 030162 0 ustar twerner twerner
How can I create an upload bundle containing sources and javadoc for a project?
You can do that by running the javadoc:jar and
sources:jar goals before repository:bundle-create:
mvn sources:jar javadoc:jar repository:bundle-create
How can I create an upload bundle for a project that I don't build using maven?
You can manually add the artifact to your local repository, creating a POM and optionally adding source and
javadoc jars. Then you can run mvn repository:bundle-pack that will prompt you for groupId, artifactId and
version and will generate a bundle that you can use for an upload request.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-stage-plugin/ 0000755 0001750 0001750 00000000000 11632765550 025030 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-stage-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 025606 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-stage-plugin/fml/faq.fml 0000644 0001750 0001750 00000002575 11055554323 027057 0 ustar twerner twerner
Why isn't my username being picked up when I specify a repositoryId?
The plugin will pick up the username/password from your
settings.xml file. Make sure that you are using the same
id in your settings.xml that you are using
on the command line.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-jar-plugin/ 0000755 0001750 0001750 00000000000 11632765551 024502 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-jar-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025260 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-jar-plugin/fml/faq.fml 0000644 0001750 0001750 00000002475 11055554323 026527 0 ustar twerner twerner
Why is there no documentation for the archive parameter?
The archive parameter is a class that resides outside of this plugin,
in the Maven Archiver component. You can find the documentation for
Maven Archiver
here.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-rar-plugin/ 0000755 0001750 0001750 00000000000 11632765551 024512 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-rar-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025270 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-rar-plugin/fml/faq.fml 0000644 0001750 0001750 00000004145 11055554323 026533 0 ustar twerner twerner
Is the rar file generated by the maven-rar-plugin is the same with the rar file(compressed file) of WinRar?
No. They are entirely different from each other.
A Resource Adapter Archive (RAR) file is a Java archive (JAR) file used to package a resource adapter for the Java 2 Connector (J2C) Architecture
A RAR file can contain the following:
Enterprise information system (EIS) supplied resource adapter implementation code in the form of JAR files or other runnable components, such as dynamic link lists.
Utility classes.
Static documents, such as HTML files, images, and sound files.
While RAR(Roshal ARchive) is the native format of WinRAR archiver. Like other archives, RAR files
are data containers, they store one or several files in the compressed form.
After you downloaded RAR file from Internet, you need to unpack its contents in order to use it.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-dependency-plugin/ 0000755 0001750 0001750 00000000000 11632765551 026044 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-dependency-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026622 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-dependency-plugin/fml/faq.fml 0000644 0001750 0001750 00000007611 11055554323 030066 0 ustar twerner twerner
What is the difference between dependency-maven-plugin and maven-dependency-plugin?
Actually, they are the same, it's just that it was moved and renamed. The dependency-maven-plugin
is hosted at Mojo while maven-dependency-plugin is hosted at Apache. The recommended
plugin to use is the maven-dependency-plugin.
When executing mvn dependency:unpack or dependency:copy from the command line, I get "One or more required plugin parameters are invalid/missing for 'dependency:unpack'"
In order for this to work, you must configure the ArtifactItems as shown here. Note that when executing a plugin from
the command line, you must put the configuration tag outside of the executions.
If you haven't done this correctly, the error will look like this:
[0] inside the definition for plugin: 'maven-dependency-plugin'specify the following:
Why am I getting errors that a documented goal or parameter is missing?
The latest documents are published and may preceed the actual release. Check to make sure the goal/parameter is in the most recent version.
-OR-
Maven may be resolving the older codehaus version of the dependency plugin. See next question.
Why is Maven resolving "dependency:xxx" to the older org.codehaus.mojo:dependency-maven-plugin?
Due to a bug in Maven in versions prior to 2.0.7 (MNG-2926) the search order was reversed and caused Mojo plugins to supercede ones with the same prefix at Apache.
The metadata at mojo was cleaned up when the maven-dependency-plugin was released at Apache. If you are still experiencing this error, chances are you have
old metadata in your local repository or in a proxy / internal repository. Removing /org/codehaus/mojo/maven-metadata.* from your repo/proxy will cause it to
be refreshed. Alternatively, you can specify the groupId explicitely in your pom (if you are using a bound goal), or on the command line, use groupId:artifactId:version:mojo, ie mvn
org.apache.maven.plugins:maven-dependency-plugin:2.0-alpha-4:unpack
Why am I having trouble unpacking only a specific file?
The excludes will override the includes declaration. That means if you specify excludes=**/* ,includes=**/foo, you will exclude everything. If you only want foo, then just specify the includes. The plexus component used to unpack uses the following code to determing which files to unpack: return isIncluded( name ) AND !isExcluded( name );
The site generation done by the Site Plugin and the Project Info
Reports Plugin is fully internationalized. This means that adapting them
to another language, a process known as localization, is very easy. All
that is needed is to download a couple of properties files and start
translating the texts in them. If you want to provide a patch for an
unsupported language, there are
detailed instructions below.
There are currently three files that needs to be localized to support a
new language. The following table summarizes the currently supported
languages.
Note: The files linked to below are the files used in the latest
development code. So the files may be newer than the ones included in
the latest release.
If you want to contribute a localization, follow these steps:
Download each of the three properties files linked above as
the base for your translation. Pick files from a language that you
understand well, for instance English.
Rename the files to the wanted locale. For example,
site-plugin_de.properties for a new German
translation for the Maven Site Plugin.
Translate the files contents using your preferred text editor.
The files must use US-ASCII encoding. For characters that are not
included in US-ASCII you must use Unicode escapes, like "\u8ff0".
See the tools section below for examples of tools that can help
you to convert your texts to use Unicode escapes.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-site-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 025447 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-site-plugin/fml/faq.fml 0000644 0001750 0001750 00000012116 11055554323 026710 0 ustar twerner twerner
What is the difference between mvn site and mvn site:site?
mvn site
Calls the site lifecycle with the associate phases (i.e. pre-site, site, post-site, site-deploy).
See Lifecycle Reference.
mvn site:site
Calls the site goal from the site plugin.
See site:site.
How do I Integrate static (X)HTML pages into my Maven site?
You can integrate your static pages by following these steps:
Put your static pages in the resources directory, ${basedir}/src/site/resources
Create your site.xml and put it in ${basedir}/src/site
Link to the static pages by modifying the menu section, create items and map them to the filenames of the static pages
Why do my absolute links get translated into relative links?
This happens because the Site Plugin tries to make all URLs relative,
when possible. If you have something like this defined in your
pom.xml:
http://www.your.site.com/
and create links in your site.xml (just an example) like
this:
You will see that the link to "Your site" will be a relative one, but
that the link to "Maven 2" will be an absolute link.
Why don't the links between parent and child modules work when I run "mvn site"?
What "mvn site" will do for you, in a multi-project
build, is to run "mvn site" for the parent and all its
modules individually. The links between parent and child will
not work here. They will however work when you deploy
the site.
If you want to test this, prior to deployment, you can run the
site:stage goal as
described in the usage documentation
instead.
How to include a custom Doxia module, like Twiki?
The site plugin handles out-of-box apt, xdoc and fml formats. If you
want to use a custom format like Twiki, you need to specify the
Doxia Twiki dependency, i.e.:
...
...
org.apache.maven.pluginsmaven-site-pluginorg.apache.maven.doxiadoxia-module-twiki1.0-alpha-11
...
You can set the Checkstyle properties to be used in the plugin configuration of your pom through the
propertiesLocation parameter. The properties file will be resolved by the plugin based
on its value.
How do I set a custom ruleset?
You can set a custom ruleset through the configLocation plugin parameter. If no value is
specified, the plugin will use a default ruleset, which is the sun_checks.xml, that is bundled with the
plugin.
How do I include the test directory in Checkstyle?
You can include the test directory in the Checkstyle report by setting the
includeTestSourceDirectory plugin parameter to true.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-remote-resources-plugin/ 0000755 0001750 0001750 00000000000 11632765550 027230 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-remote-resources-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 030006 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-remote-resources-plugin/fml/faq.fml 0000644 0001750 0001750 00000007143 11055554323 031253 0 ustar twerner twerner
Why do I need to use this plugin?
This plugin greatly reduces the pain associated with consistent packaging concerns across
a large set of projects, or an entire organization. Any project can specify the use of a
remote resource bundle and have the resources incorporated into their packaging. This means
that you can create standard settings in a parent POM somewhere in the project hierarchy and
have all projects use packaged common resources in a standard way like licenses, other legal
notices and disclaimers, or anything else that may be common.
The generated files have a lot of missing information. Looking at the poms from
the dependencies, the information isn't there either. What can I do?
There are two solutions:
File bugs with the projects that produced those artifacts to get them to fix them. Also,
file bugs with the
Maven Evangelism
project to have the Maven people enhance the metadata in the repository.
Use a supplemental data file. You can create a file that contains the missing metadata.
For example:
com.sun.xml.bindjaxb-implSun JAXB Reference Implementation RuntimeSun Microsystemshttp://www.sun.com/COMMON DEVELOPMENT AND DISTRIBUTION LICENSE (CDDL) Version 1.0http://www.sun.com/cddl/cddl.html
That location for that file can then be configured in the
supplementalModels configuration element for the process mojo. The
supplemental information is merged into the information provided from the repository.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-verifier-plugin/ 0000755 0001750 0001750 00000000000 11632765550 025540 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-verifier-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026317 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-verifier-plugin/fml/faq.fml 0000644 0001750 0001750 00000002103 11055554323 027552 0 ustar twerner twerner
Can it verify other things like URLs?
No.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changes-plugin/ 0000755 0001750 0001750 00000000000 11632765552 025337 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changes-plugin/xdoc/ 0000755 0001750 0001750 00000000000 11632765552 026274 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changes-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765552 026115 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changes-plugin/fml/faq.fml 0000644 0001750 0001750 00000004704 11055554323 027360 0 ustar twerner twerner
What's the difference between the changes-maven-plugin at Mojo and this one?
This plugin started out at the Mojo project.
In March of 2006 the plugin was moved to Apache and the Maven sandbox.
So it's the same plugin, but this one is newer.
I get a org.xml.sax.SAXParseException, when generating the JIRA Report. What can do about it?
If you have a lot of entities in the xml file returned from your JIRA
installation, you might get an error like this one, when you run the
JIRA Report:
org.xml.sax.SAXParseException: Parser has reached the entity expansion limit "64,000" set by the Application.
If that happens you need to tell the xml parser to use a higher limit.
This can be accomplished by adding a command line parameter. In the
following example we have set it to double the original value:
mvn -DentityExpansionLimit=128000 ...
Unfortunately we have not been able to set this in Java. If someone
knows how to do this, then please reopen
MCHANGES-75,
and tell us how. It would be nicer if this could be set using a
parameter in the POM.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-idea-plugin/ 0000755 0001750 0001750 00000000000 11632765550 024627 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-idea-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 025405 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-idea-plugin/fml/faq.fml 0000644 0001750 0001750 00000003504 11055554323 026647 0 ustar twerner twerner
Is this the IDEA Plugin that allows me to run Maven commands from within IntelliJ IDEA?
No. This is a Maven plugin to generate IntelliJ IDEA files for a Maven project. This is not an IDEA Plugin for Maven.
How does the IDEA plugin work on multi-projects?
Maven IDEA Plugin, by default, creates the project file (*.ipr) and
the workspace file (*.iws) from where the root pom is located. Then
module files (*.iml) are created for each of the projects inside the
reactor.
If some projects depend on another project in the reactor, then the
reference to the project is given instead of the hard-references to
the local repository copies of the artifacts.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-install-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025374 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-install-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026152 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-install-plugin/fml/faq.fml 0000644 0001750 0001750 00000002340 11055554323 027410 0 ustar twerner twerner
Can I use the install:install-file goal to install artifacts to my remote repository?
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-clean-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025010 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-clean-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025566 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-clean-plugin/fml/faq.fml 0000644 0001750 0001750 00000005315 11055554323 027031 0 ustar twerner twerner
I already ran mvn clean but the directory (put dir name here) is still there. What should I do?
Some files-generating plugins can generate their files outside of the
default directories being deleted by the clean plugin. You should add
the location of such files in the clean plugin configuration or change
the configuration of those plugins to put their files inside the
project.build.directory which is by default, the target
directory.
On Windows, I got "Unable to delete directory". What's wrong?
For instance, clean could fail if you already have opened a command
line with target as the current dir. Windows locks some ressources and you need
to close the handles on these ressources.
To skip these errors, you could call clean with the command line parameter -Dmaven.clean.failOnError=false.
For more information, refer to Ignoring Errors page.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-invoker-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025403 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-invoker-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026161 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-invoker-plugin/fml/faq.fml 0000644 0001750 0001750 00000006675 11056460046 027435 0 ustar twerner twerner
Why do I need to use this plugin?
It is essential that you provide some form of integration testing for your projects and the Invoker Plugin
tries to make is easy for you to create integration tests for your Maven Plugins, new Lifecycles, or any other
type of Maven component that you've created. Currently the Invoker Plugin forks Maven to execute the specified
projects, but it is hoped that soon we will integrate the Maven Embedder into the mix to allow you run your
projects in process for great speed.
How can I assert that the build of an IT project fails?
Sometimes you might want to test that error conditions are properly dealt with, i.e. fail a build. To assert
a failure for a particular IT project, put the following setting into the properties file denoted by the
plugin's invokerPropertiesFile parameter:
invoker.buildResult=failure
Now, the failure of the IT build will be interpreted as a test success. Likewise, a successful IT build will
be considered a test failure.
How can I share common code between the pre-/post-build scripts?
If you want to avoid copy&paste of lengthy code snippets within the hook scripts, you can move this code
into a regular Java class. More precisely, you would place this utility code somewhere in your test source
tree and set the plugin parameter addTestClassPath
to true. For more details, please see the example
Accessing Test Classes.
How can I invoke multiple Maven builds on the same IT project?
This is not supported in the plugin configuration but rather on a per project basis by means of the invoker
properties. This way, you use properties like invoker.goals.2 to configure the goals for a second
invocation of Maven. Have a look at the example about using
Invoker Properties.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-one-plugin/ 0000755 0001750 0001750 00000000000 11632765551 024507 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-one-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025265 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-one-plugin/fml/faq.fml 0000644 0001750 0001750 00000003510 11055554323 026523 0 ustar twerner twerner
Will this plugin allow me to use Maven 1.x plugins in Maven 2?
No it will not, but it will allow you to package, install and deploy a
Maven 1.x plugin using Maven 2.
What's the difference between one:deploy-maven-one-repository
and deploy:deploy-file with repositoryLayout set to legacy?
If you'd use deploy:deploy-file then you'd need to
configure the file, groupId, artifactId, version for it, whereas with
this plugin you don't need to configure anything but the repository,
as it gets the rest from the pom. It's more like
deploy:deploy than it is deploy:deploy-file.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changelog-plugin/ 0000755 0001750 0001750 00000000000 11632765550 025654 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changelog-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 026432 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-changelog-plugin/fml/faq.fml 0000644 0001750 0001750 00000020111 11055554323 027665 0 ustar twerner twerner
What is the difference between the Changelog plugin and the Changes plugin?
The Changelog plugin generates reports based on the changes in the Software Configuration Management or SCM while
the Changes plugin generates reports either from a changes.xml file or from the JIRA issue management system.
For more information about the changes plugin, see
http://maven.apache.org/plugins/maven-changes-plugin
What is Software Configuration Management or SCM?
According to Roger Pressman (in his book) Software Engineering: A Practitioner's Approach, SCM is a "set of activities
designed to control change by identifying the work products that are likely to change, establishing relationships among
them, defining mechanisms for managing different versions of these work products, controlling the changes imposed, and
auditing and reporting on the changes made."
Why do the dates look weird in the report when I use the dateFormat parameter?
The dateFormat parameter is used when parsing the dates
from the log entries retrieved from your SCM system. It can
not be used to format the dates in the report. If
you try to do this the parsed dates will be wrong and the dates in
the report even more so. They can look like this
0020-05-27 for a file that was changed on 14 december
2005.
How can I debug the SCM command?
When you generate the report, you will see output like this on the
command line:
[INFO] [changelog:changelog]
[INFO] Generating changed sets xml to: .../target/changelog.xml
[INFO] Executing: svn --non-interactive log -v -r "{2007-06-13 22:22:09 +0000}:{2007-07-14 22:22:09 +0000}" http://svn.apache.org/repos/asf/maven/plugins/trunk/maven-site-plugin
Copy the SCM command (everything after Executing:) and
try to run it by itself on the command line. If it doesn't work on
the command line there's probably something wrong with the
<scm> element in your pom.xml.
My changelog report is blank, but it shouldn't be
The first thing to check is what data the changelog plugin managed to
pull out of your SCM system. In the file
target/changelog.xml you will find that data. Have a
look and see if the data in the file seems correct. If it is not
correct, then you are not getting the data you expected from your SCM
system. Please check your changelog plugin configuration.
If that doesn't help, you can try to run the maven-scm-plugin from
the command line. The maven-changelog-plugin uses Maven SCM under the
hood and running the maven-scm-plugin is a great way of verifying
that the <scm> element in your
pom.xml file is correct. Try this on the command line:
mvn scm:changelog
It should show you the latest changes made in your SCM. It uses the
default settings, but you can change these by specifying parameters
on the command line. Read more about this in
the scm-plugin documentation.
Where can I find a working configuration for this plugin?
The plugin itself is configured to generate a changelog report. This
is done using the bare minimum of configuration. Have a look at the
<scm> and
<reporting>/<plugins> elements in the
pom.xml
of this plugin. The generated report is found
here.
How do I use this plugin with Perforce?
You have to specify your clientspec in the
<systemProperties> element of this plugin's
<configuration> element.
org.apache.maven.pluginsmaven-changelog-pluginmaven.scm.perforce.clientspec.nameyour-client-spec-name
The Developer Activity report is blank, but the other reports are fine
You need to add
<developer>
elements in your pom.xml file. Their id:s need to match
the userid:s that are used in your SCM system. Only checkins made by
a developer found in the pom will be added to the Developer Activity
report.
I think I've found a bug in this plugin, what do I do?
Please follow these steps in the order they come.
Read all the FAQs on this page.
Ask a question on the user list. Please supply the necessary
information so that the people on the list can help you. This
includes the <scm> element from your
pom.xml, your plugin configuration plus a rich
description of what happens and what you expected to happen.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-ant-plugin/ 0000755 0001750 0001750 00000000000 11632765550 024507 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-ant-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 025265 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-ant-plugin/fml/faq.fml 0000644 0001750 0001750 00000002616 11055554323 026532 0 ustar twerner twerner
Where are the generated Ant build files?
The files are generated in the Maven ${basedir} directory.
What are the generated key tasks?
The key tasks are: clean, compile, compile-tests, test, javadoc, package.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-deploy-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025222 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-deploy-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026000 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-deploy-plugin/fml/faq.fml 0000644 0001750 0001750 00000005156 11055554323 027246 0 ustar twerner twerner
I get an Unsupported Protocol Error when deploying a 3rd party jar. What should I do?
If you are using the deploy:deploy-file goal and encounter
this error:
"Error deploying artifact: Unsupported Protocol: 'ftp': Cannot find
wagon which supports the requested protocol: ftp"
Then you need to place the appropriate wagon provider in your
%M2_HOME%/lib. In this case the provider needed is ftp,
so we have to place the wagon-ftp jar in the lib directory of your
Maven 2 installation.
If the error description is something like this:
"Error deploying artifact: Unsupported Protocol: 'ftp': Cannot find
wagon which supports the requested protocol: ftp
org/apache/commons/net/ftp/FTP"
Then you need to place the commons-net jar in
%M2_HOME%/lib.
I don't want to deploy one of the artifacts in my multi-module build. Can I skip deployment?
Yes, you can skip deployment of individual modules by configuring the deploy plugin as follows:
maven-deploy-pluginX.Ytrue
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-compiler-plugin/ 0000755 0001750 0001750 00000000000 11632765550 025537 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-compiler-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 026315 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-compiler-plugin/fml/faq.fml 0000644 0001750 0001750 00000004047 11055554323 027562 0 ustar twerner twerner
Is there a way to get Maven to report the number of compile errors found?
Currently, this type of summary information is not built into the compiler plugin, but it
would be possible to add. If this feature is important to you, add your vote to
MNG-1854
.
How do I add my generated sources to the compile path of Maven, when using modello?
Modello generate the sources in the generate-sources phase and automatically adds the
source directory for compilation in maven. So you don't have to copy the generated sources.
You have to declare the modello-plugin in the build of your plugin for source generation
(in that way the sources are generated each time).
An EAR archive is used to deploy standalone EJBs, usually separated from the web application. Thus, there is no
need for a web application to access these EJBs. The EJBs are still accessible though using EJB clients.
The EAR Plugin throws an exception when encountering artifact types it is unfamiliar with. Is this a bug?
The exception can be prevented by adding your custom artifact type to the artifactTypeMappings configuration.
There is a mini-guide on how to do that in the modules
configuration section.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-patch-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025025 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-patch-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025603 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-patch-plugin/fml/faq.fml 0000644 0001750 0001750 00000003675 11055554323 027055 0 ustar twerner twerner
What would a patch plugin even be used for?
In certain environments direct source modification is not allowed so to make alterations to the source you
need some patch application process. This plugin seeks to address those situations.
Why doesn't this work on Windows?
This plugin wraps the GNU patch tool, which must be in your
PATH in order to function properly. A Windows installation usually does not ship with this tool so
you will need to install it manually. You might be able to get this plugin working within
Cygwin or by using the port
Patch for Windows.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-docck-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025011 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-docck-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025567 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-docck-plugin/fml/faq.fml 0000644 0001750 0001750 00000003554 11063234277 027037 0 ustar twerner twerner
Where did the standard came from?
The plugin documentation standard was created to address the frequent
complaint of lack of documentation, specifically for the Maven plugins.
The standard was based on suggestions made on the Maven dev mailing
list with some refinements. It is a community consensus of what basic
documentation a Maven plugin should have.
Why do we need a documentation standard?
The standard is not a set of rules but a guide to help plugin
developers document their plugins better, for the benefit of the users
of the plugin. The standard also reminds the plugin developers of the
important details that needs to be documented, to help speed up the
adoption of the plugin.
DOAP stands for "Description of a Project" and you can find out everything there is to
know about DOAP in its homepage and in this article.
What are the benefits of DOAP?
The Semantic Web provides
mechanisms to process data provided in a form that is easily processed by machines. Thus,
a DOAP is a machine readable document which facilitates projects research: it becomes much
easier to seek information in the mass of data of the Web, since the data have a given
foreseeable format.
Why would I use DOAP when I have a POM?
That's a very good question! The answer is that generating a DOAP file should take no
effort if you are using Maven DOAP Plugin and it helps disseminate project information
which can only be a good thing. Cataloging tools like SWiK
or like DoapStore can benefit from you generating DOAP
files and that can also only be a good thing. Even so, it is still important to spread as
much information about projects around as possible so there is no downside to creating
DOAP files.
What to do with the generated DOAP file?
Maven DOAP plugin has generated a DOAP file, what's next? See DOAP in Use part.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-eclipse-plugin/ 0000755 0001750 0001750 00000000000 11632765550 025351 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-eclipse-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765550 026127 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-eclipse-plugin/fml/faq.fml 0000644 0001750 0001750 00000004607 11055554323 027376 0 ustar twerner twerner
Is this the Eclipse Plugin that allows me to run maven commands from within Eclipse IDE?
No. This is a maven plugin to generate Eclipse files for a maven project. This is not an Eclipse Plugin for Maven.
I already did mvn eclipse:eclipse but when I open Eclipse, my project is not there. Where is it?
You may also need to import the project created by Maven Eclipse Plugin. More information can be found here.
After running mvn eclipse:eclipse, the generated dependencies are pointing to a non-existing file. What needs to be done?
Before you can setup any maven project to your Eclipse IDE, you need to define first the location of your local repository to Eclipse. This is done by using: eclipse:add-maven-repo
Can I make the Eclipse plugin download and attach javadocs to my libraries?
As of version 2.4, there is a new flag, downloadJavadocs that behaves exactly like downloadSources except for javadocs. See more information here: Attach Library Sources.
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-assembly-plugin/ 0000755 0001750 0001750 00000000000 11632765551 025545 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-assembly-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 026323 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-assembly-plugin/fml/faq.fml 0000644 0001750 0001750 00000006145 11055554323 027570 0 ustar twerner twerner
If the Assembly Plugin is run during the package phase, do my assemblies get deployed during the deploy phase?
Yes. The assemblies created by the Assembly Plugin is attached to your project so it gets deployed too.
Can I use an artifact created by the assembly plugin as a dependency?
Yes. You can refer to it using the id of the assembly as the dependency classifier.
How do I use the Assembly Plugin to package my project's javadoc files?
The Javadoc Plugin can generate the javadoc files of your projects. Also, the Javadoc Plugin can package them!
I have a dependencySet that includes some artifacts with classifiers, and others without classifiers.
How can I setup the file mappings to handle both cases appropriately?
The best way to handle a mixed bag of dependencies with and without classifiers is to use the
${dashClassifier?} expression, added in version 2.2-beta-2 of the assembly plugin especially
for this purpose. This expression will determine whether each artifact has a classifier, and if it
does, it will substitute the artifact's classifier - prepended by a dash - in place of the expression.
For example, suppose you want to include two artifacts, commons-logging-1.0.4.jar, and
yourserver-1.0-client.jar (where 'client' is the classifier of the second artifact). To do this,
simply add the following to your dependencySet:
An 'xdoc' is an XML document conforming to a small and simple set of tags.
Xdoc was the primary documentation format in Maven 1,
Maven 2 largely replaced this by Apt, but xdoc is still supported.
Historically, the xdoc format can be traced back to the
Anakia format, as once used by the
Apache Jakarta project.
The Maven 1 Xdoc plugin introduced a few additions to the Anakia format, they are highlighted in the
plugin documentation.
The following is a sample XDoc document:
Page TitleJohn Doe
Hi!
Subsection!
code line 1
code line 2
]]>
Doxia will produce <h2> and
<h3> headings for <section>
and <subsection> elements, respectively.
It is therefore perfectly valid to put some sub-headings
(<h4>, <h5>,
<h6>) inside a subsection. For instance,
A subsubsection]]>
will produce:
A subsubsection
The core doxia modules do not construct anchors from
section/subsection names. If you want to reference a section,
you should either provide an explicit anchor:
]]>
or use an id attribute for section and subsections
(note that id's have to be unique within one xdoc
source document):
]]>
Note that this differs from previous behavior, where anchors
were constructed from section/subsection names, replacing special
characters by underscores. This behavior presents two shortcomings:
If two sections or subsections have identical names
(within one source document), you will get an ambiguity when
referencing them. Also the resulting html document will not be
valid XHTML. For other output formats (eg pdf), it might even be impossible
to generate the target document.
For long section titles, this leads to rather cumbersome anchor names.
If automatic anchor generation is desired for a particular output format,
it should be implemented / overridden by the corresponding low-level Sink.
Doxia is currently not able to validate your xdoc files as no schema or DTD
exists yet (however this is planned before the 1.0 release).
It is therefore necessary to check manually whether your source files are valid xdocs,
this should ensure that the generated html files are valid
XHTML1-transitional.
Here is a list of common mistakes to be aware of:
Wrong:
Here's a list:
item 1
item 2
of things to do.
]]>
Correct:
Here's a list:
item 1
item 2
of things to do.
]]>
Typical block level elements are list elements,
<table>, <source>,
<div>, <p> and
<pre>.
The following table gives an overview of the markup languages currently
supported by Doxia. If a Parser is available for a given format, it
means that you can write your documentation in this language and Doxia
can generate output from it. If a Sink is available, it means you can
generate output in this format.
The source directory is the directory under which Maven expects source
documents in this format (e.g. src/site/apt/ for Apt), the
extension is the default file extension, and the parser id is gives the
unique identifier that is used by plexus to lookup the corresponding
component.
Please consult the Modules Guide
for links to reference documentation of external formats.
An 'fml' is an XML document conforming to a small and simple set of tags.
The format was first used in the Maven 1,
version of the FAQ plugin.
The following is a sample FML document:
General
What is Foo?
some markup goes here
some source code
some markup goes here
What is Bar?
some markup goes here
Installation
How do I install Foo?
some markup goes here
]]>
doxia-1.1.4/doxia-test-docs/src/main/resources/doxia-site/fml/ 0000755 0001750 0001750 00000000000 11632765551 024152 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/doxia-site/fml/faq.fml 0000644 0001750 0001750 00000010735 11215432700 025407 0 ustar twerner twerner
How to handle style in the APT markup language?
APT doesn't currently support style. It is in the roadmap.
How to export in PDF?
There are two modules available that can be used to generate pdf output: an
iText module
that uses the
iText framework, and a
FO module,
that can be used e.g. in conjunction with
Apache FOP to generate a pdf.
Unfortunately, the iText team has discontinued the XML to PDF functionalities, so probably
only the fo module is going to be supported in the future.
A pdf plugin for m2 is currently in development in the Doxia sandbox. You can get the source
here.
Is it possible to create a book?
Doxia also has a fairly simple tool for writing books. It comes complete with a Maven plugin
to produce PDFs, LaTeX documents and Xdoc for direct integration in your Maven site.
The Doxia Book code
is still limited but fully functional.
Why XML based sinks don't generate nicely formatted documents?
We decided to keep pretty printing out of the core modules. So, XML based sinks like Xdoc or XHTML are
intentionally unformatted. You could always do this after the document generation or directly
by creating a specialized end-user sink (see DOXIA-255).
Where are the Maven Doxia XSD schemas for Xdoc and FML files?
The Xdoc XSD is located here and
the FML XSD is located here.
Your favorite IDE probably supports XSD schema's for Xdoc and FML files. You need to
specify the following:
<document xmlns="http://maven.apache.org/XDOC/2.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/XDOC/2.0 http://maven.apache.org/xsd/xdoc-2.0.xsd">
...
</document>
<faqs xmlns="http://maven.apache.org/FML/1.0.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/FML/1.0.1 http://maven.apache.org/xsd/fml-1.0.1.xsd">
...
</faqs>
doxia-1.1.4/doxia-test-docs/src/main/resources/maven-pmd-plugin/ 0000755 0001750 0001750 00000000000 11632765551 024506 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-pmd-plugin/fml/ 0000755 0001750 0001750 00000000000 11632765551 025264 5 ustar twerner twerner doxia-1.1.4/doxia-test-docs/src/main/resources/maven-pmd-plugin/fml/faq.fml 0000644 0001750 0001750 00000002550 11055554323 026525 0 ustar twerner twerner
The PMD report takes a long time to generate. Is there any way to skip
the PMD or CPD reports temporarily?
Yes, each report supports a skip parameter which you can pass on the
command line, -Dpmd.skip=true and
-Dcpd.skip=true respectively.
doxia-1.1.4/doxia-core/ 0000755 0001750 0001750 00000000000 11632765554 014627 5 ustar twerner twerner doxia-1.1.4/doxia-core/pom.xml 0000644 0001750 0001750 00000007024 11470562366 016143 0 ustar twerner twerner
4.0.0org.apache.maven.doxiadoxia1.1.4../pom.xmldoxia-coreDoxia :: CoreDoxia core classes and interfaces.org.apache.maven.doxiadoxia-sink-apiorg.apache.maven.doxiadoxia-logging-apiorg.codehaus.plexusplexus-utilsorg.codehaus.plexusplexus-container-defaultxercesxercesImpl2.9.1commons-langcommons-lang2.4org.apache.httpcomponentshttpclient4.0.2org.apache.maven.pluginsmaven-jar-plugintest-jarorg.codehaus.modellomodello-maven-plugindescriptorgenerate-sourcesjavaxpp3-readerxpp3-writerxsddocspre-sitexdocxsd1.0.1src/main/mdo/document.mdo
doxia-1.1.4/doxia-core/src/ 0000755 0001750 0001750 00000000000 11632765554 015416 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/ 0000755 0001750 0001750 00000000000 11632765553 016374 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/resources/ 0000755 0001750 0001750 00000000000 11632765553 020406 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/resources/macro/ 0000755 0001750 0001750 00000000000 11632765553 021507 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/resources/macro/snippet/ 0000755 0001750 0001750 00000000000 11632765553 023171 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/resources/macro/snippet/testSnippet.txt 0000644 0001750 0001750 00000000262 11163507633 026244 0 ustar twerner twerner
preamble
SNIPPET START firstId
first snippet
SNIPPET END firstId
interlude
another snippet to start: secondId
second snippet
another snippet to end: secondId
conclusion
doxia-1.1.4/doxia-core/src/test/java/ 0000755 0001750 0001750 00000000000 11632765552 017314 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/ 0000755 0001750 0001750 00000000000 11632765552 020103 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765552 021324 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765552 022432 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765553 023537 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/ 0000755 0001750 0001750 00000000000 11632765552 024637 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/ 0000755 0001750 0001750 00000000000 11632765552 026321 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/snippet/SnippetMacroTest.java 0000644 0001750 0001750 00000010527 11163507633 032426 0 ustar twerner twerner package org.apache.maven.doxia.macro.snippet;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
import org.codehaus.plexus.PlexusTestCase;
/**
* Test snippet macro.
*
* @author ltheussl
*/
public class SnippetMacroTest
extends PlexusTestCase
{
/**
* Test of execute method, of class SnippetMacro.
*
* @throws MacroExecutionException if a macro fails during testing.
*/
public void testExecute()
throws MacroExecutionException
{
File basedir = new File( getBasedir() );
Map macroParameters = new HashMap();
macroParameters.put( "file", "src/test/resources/macro/snippet/testSnippet.txt" );
SinkEventTestingSink sink = new SinkEventTestingSink();
MacroRequest request = new MacroRequest( macroParameters, basedir );
SnippetMacro macro = new SnippetMacro();
macro.execute( sink, request );
Iterator it = sink.getEventList().iterator();
assertEquals( "verbatim", ( (SinkEventElement) it.next() ).getName() );
SinkEventElement event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
String snippet = (String) event.getArgs()[0];
assertEquals( "verbatim_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
assertTrue( snippet.indexOf( "preamble" ) != -1 );
assertTrue( snippet.indexOf( "first snippet" ) != -1 );
assertTrue( snippet.indexOf( "interlude" ) != -1 );
assertTrue( snippet.indexOf( "second snippet" ) != -1 );
assertTrue( snippet.indexOf( "conclusion" ) != -1 );
// again
macroParameters.put( "id", "firstId" );
macroParameters.put( "verbatim", "" );
sink.reset();
request = new MacroRequest( macroParameters, basedir );
macro.execute( sink, request );
it = sink.getEventList().iterator();
assertEquals( "verbatim", ( (SinkEventElement) it.next() ).getName() );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
snippet = (String) event.getArgs()[0];
assertEquals( "verbatim_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
assertTrue( snippet.indexOf( "preamble" ) == -1 );
assertTrue( snippet.indexOf( "first snippet" ) != -1 );
assertTrue( snippet.indexOf( "interlude" ) == -1 );
assertTrue( snippet.indexOf( "second snippet" ) == -1 );
assertTrue( snippet.indexOf( "conclusion" ) == -1 );
// again
macroParameters.put( "id", "secondId" );
macroParameters.put( "verbatim", "false" );
sink.reset();
request = new MacroRequest( macroParameters, basedir );
macro.execute( sink, request );
it = sink.getEventList().iterator();
event = (SinkEventElement) it.next();
assertEquals( "rawText", event.getName() );
snippet = (String) event.getArgs()[0];
assertFalse( it.hasNext() );
assertTrue( snippet.indexOf( "preamble" ) == -1 );
assertTrue( snippet.indexOf( "first snippet" ) == -1 );
assertTrue( snippet.indexOf( "interlude" ) == -1 );
assertTrue( snippet.indexOf( "second snippet" ) != -1 );
assertTrue( snippet.indexOf( "conclusion" ) == -1 );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/manager/ 0000755 0001750 0001750 00000000000 11632765552 026251 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/manager/MacroManagerTest.java 0000644 0001750 0001750 00000003144 11166632523 032303 0 ustar twerner twerner package org.apache.maven.doxia.macro.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.macro.Macro;
import org.codehaus.plexus.PlexusTestCase;
/** @author Jason van Zyl */
public class MacroManagerTest
extends PlexusTestCase
{
/**
* Test MacroManager.
*
* @throws java.lang.Exception if any.
*/
public void testMacroManager()
throws Exception
{
MacroManager mm = (MacroManager) lookup( MacroManager.ROLE );
assertNotNull( mm );
Macro macro = mm.getMacro( "snippet" );
assertNotNull( macro );
try
{
macro = mm.getMacro( "weirdId" );
fail( "should not exist!" );
}
catch ( MacroNotFoundException macroNotFoundException )
{
assertNotNull( macroNotFoundException );
}
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/EchoMacroTest.java 0000644 0001750 0001750 00000005121 11163507633 030172 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import junit.framework.TestCase;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
/**
* Test echo macro.
*
* @author ltheussl
*/
public class EchoMacroTest
extends TestCase
{
/**
* Test of execute method, of class EchoMacro.
*/
public void testExecute()
{
Map macroParameters = new HashMap();
macroParameters.put( "paramName", "paramValue" );
macroParameters.put( "parser", "parserValue" );
macroParameters.put( "sourceContent", "sourceContentValue" );
SinkEventTestingSink sink = new SinkEventTestingSink();
MacroRequest request = new MacroRequest( macroParameters, new File( "." ) );
new EchoMacro().execute( sink, request );
Iterator it = sink.getEventList().iterator();
SinkEventElement event = (SinkEventElement) it.next();
assertEquals( "verbatim", event.getName() );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertEquals( "echo" + Macro.EOL, (String) event.getArgs()[0] );
event = (SinkEventElement) it.next();
assertEquals( "text", event.getName() );
assertEquals( "paramName ---> paramValue" + Macro.EOL, (String) event.getArgs()[0] );
event = (SinkEventElement) it.next();
assertEquals( "verbatim_", event.getName() );
assertFalse( it.hasNext() );
}
/**
* Test log.
*/
public void testLog()
{
EchoMacro macro = new EchoMacro();
macro.enableLogging( null );
assertNotNull ( macro.getLog() );
assertNotNull ( macro.getLog() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/toc/ 0000755 0001750 0001750 00000000000 11632765552 025424 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/toc/TocMacroTest.java 0000644 0001750 0001750 00000020100 11245330530 030607 0 ustar twerner twerner package org.apache.maven.doxia.macro.toc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.StringWriter;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import junit.framework.TestCase;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.parser.XhtmlBaseParser;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
import org.apache.maven.doxia.sink.XhtmlBaseSink;
/**
* Test toc macro.
*
* @author ltheussl
* @version $Id: TocMacroTest.java 808200 2009-08-26 22:04:08Z vsiveton $
*/
public class TocMacroTest
extends TestCase
{
/**
* Test of execute method, of class TocMacro.
*
* @throws MacroExecutionException if a macro fails during testing.
*/
public void testExecute()
throws MacroExecutionException
{
String sourceContent = "
";
XhtmlBaseParser parser = new XhtmlBaseParser();
parser.setSecondParsing( true );
Map macroParameters = new HashMap();
macroParameters.put( "parser", parser );
macroParameters.put( "sourceContent", sourceContent );
macroParameters.put( "section", "sec1" );
File basedir = new File( "" );
StringWriter out = new StringWriter();
XhtmlBaseSink sink = new XhtmlBaseSink( out );
MacroRequest request = new MacroRequest( macroParameters, basedir );
TocMacro macro = new TocMacro();
macro.execute( sink, request );
assertTrue( out.toString().indexOf( "h21" ) != -1 );
assertTrue( out.toString().indexOf( "h22" ) != -1 );
assertTrue( out.toString().indexOf( "h3" ) != -1 );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/macro/SwfMacroTest.java 0000644 0001750 0001750 00000006101 11163507633 030052 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import junit.framework.TestCase;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
/**
* Test swf macro.
*
* @author ltheussl
*/
public class SwfMacroTest
extends TestCase
{
/**
* Test of execute method, of class SwfMacro.
*
* @throws MacroExecutionException if a macro fails during testing.
*/
public void testExecute()
throws MacroExecutionException
{
Map macroParameters = new HashMap();
macroParameters.put( "src", "src.swf" );
macroParameters.put( "id", "Movie" );
macroParameters.put( "width", "50" );
macroParameters.put( "height", "60" );
macroParameters.put( "quality", "best" );
macroParameters.put( "menu", "true" );
macroParameters.put( "loop", "3" );
macroParameters.put( "play", "false" );
macroParameters.put( "version", "6" );
macroParameters.put( "allowScript", "always" );
SinkEventTestingSink sink = new SinkEventTestingSink();
MacroRequest request = new MacroRequest( macroParameters, new File( "." ) );
SwfMacro macro = new SwfMacro();
macro.required( "src", "value" );
try
{
macro.required( "src", "" );
fail();
}
catch ( IllegalArgumentException e )
{
assertNotNull( e );
}
try
{
macro.required( "src", null );
fail();
}
catch ( IllegalArgumentException e )
{
assertNotNull( e );
}
macro.execute( sink, request );
Iterator it = sink.getEventList().iterator();
SinkEventElement event = (SinkEventElement) it.next();
assertEquals( "rawText", event.getName() );
assertFalse( it.hasNext() );
request = new MacroRequest( new HashMap(), new File( "." ) );
sink.reset();
macro.execute( sink, request );
it = sink.getEventList().iterator();
event = (SinkEventElement) it.next();
assertEquals( "rawText", event.getName() );
assertFalse( it.hasNext() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/document/ 0000755 0001750 0001750 00000000000 11632765553 025355 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/document/DocumentModelTest.java 0000644 0001750 0001750 00000032050 11214136275 031604 0 ustar twerner twerner package org.apache.maven.doxia.document;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
import java.util.Date;
import java.util.List;
import org.apache.maven.doxia.document.io.xpp3.DocumentXpp3Reader;
import org.apache.maven.doxia.document.io.xpp3.DocumentXpp3Writer;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.WriterFactory;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Test DocumentModel.
*
* @author ltheussl
*/
public class DocumentModelTest
extends PlexusTestCase
{
/** ISO 8601 date format, i.e. yyyy-MM-dd **/
private static final java.text.DateFormat ISO_8601_FORMAT =
new java.text.SimpleDateFormat( "yyyy-MM-dd", java.util.Locale.ENGLISH );
/**
* Test DocumentModel.
*
* @throws Exception if any.
*/
public void testDocumentModel()
throws Exception
{
DocumentModel model = getModel();
verifyModel( model );
DocumentModel copy = writeAndRecover( model );
verifyModel( copy );
assertTrue( copy.equals( model ) );
}
private DocumentModel getModel()
{
DocumentModel model = new DocumentModel();
model.setOutputName( "outputName" );
model.setModelEncoding( "ISO-8859-1" );
model.setCover( getDocumentCover() );
model.setToc( getDocumentToc() );
model.setMeta( getDocumentMeta() );
return model ;
}
private void verifyModel( DocumentModel model )
{
assertTrue( model.equals( model ) );
assertFalse( model.equals( null ) );
assertTrue ( model.hashCode() != 0 );
assertTrue( model.toString().length() > 0 );
assertEquals( "outputName", model.getOutputName() );
assertEquals( "ISO-8859-1", model.getModelEncoding() );
verifyDocumentCover( model.getCover() );
verifyDocumentTOC( model.getToc() );
verifyDocumentMeta( model.getMeta() );
}
private DocumentAuthor getAuthor( int i )
{
DocumentAuthor author = new DocumentAuthor();
author.setCity( "city" + i );
author.setCompanyName( "companyName" + i );
author.setCountry( "country" + i );
author.setEmail( "email" + i );
author.setFaxNumber( "faxNumber" + i );
author.setName( "name" + i );
author.setFirstName( "firstName" + i );
author.setInitials( "initials" + i );
author.setLastName( "lastName" + i );
author.setPhoneNumber( "phoneNumber" + i );
author.setPosition( "position" + i );
author.setPostalCode( "postalCode" + i );
author.setState( "state" + i );
author.setStreet( "street" + i );
author.setTitle( "title" + i );
return author;
}
private void verifyAuthor( DocumentAuthor documentAuthor, int i )
{
assertEquals( "city" + i, documentAuthor.getCity() );
assertEquals( "companyName" + i, documentAuthor.getCompanyName() );
assertEquals( "country" + i, documentAuthor.getCountry() );
assertEquals( "email" + i, documentAuthor.getEmail() );
assertEquals( "faxNumber" + i, documentAuthor.getFaxNumber() );
assertEquals( "name" + i, documentAuthor.getName() );
assertEquals( "firstName" + i, documentAuthor.getFirstName() );
assertEquals( "initials" + i, documentAuthor.getInitials() );
assertEquals( "lastName" + i, documentAuthor.getLastName() );
assertEquals( "phoneNumber" + i, documentAuthor.getPhoneNumber() );
assertEquals( "position" + i, documentAuthor.getPosition() );
assertEquals( "postalCode" + i, documentAuthor.getPostalCode() );
assertEquals( "state" + i, documentAuthor.getState() );
assertEquals( "street" + i, documentAuthor.getStreet() );
assertEquals( "title" + i, documentAuthor.getTitle() );
}
private DocumentCover getDocumentCover()
{
DocumentCover cover = new DocumentCover();
cover.addAuthor( getAuthor( 1 ) );
cover.setAuthor( "Author" );
cover.setCompanyLogo( "companyLogo" );
cover.setCompanyName( "companyName" );
cover.setCoverDate( new Date( 0L ) );
cover.setCoverSubTitle( "coverSubTitle" );
cover.setCoverTitle( "coverTitle" );
cover.setCoverType( "coverType" );
cover.setCoverVersion( "coverVersion" );
cover.setProjectLogo( "projectLogo" );
cover.setProjectName( "projectName" );
return cover;
}
private void verifyDocumentCover( DocumentCover cover )
{
List authors = cover.getAuthors();
assertEquals( 1, authors.size() );
verifyAuthor( (DocumentAuthor) authors.get( 0 ), 1 );
assertEquals( "Author", cover.getAuthor() );
assertEquals( "companyLogo", cover.getCompanyLogo() );
assertEquals( "companyName", cover.getCompanyName() );
assertEquals( 0L, cover.getCoverDate().getTime() );
// the actual String depends on the timezone you're in
assertEquals( ISO_8601_FORMAT.format( new Date( 0L ) ), cover.getCoverdate() );
assertEquals( "coverSubTitle", cover.getCoverSubTitle() );
assertEquals( "coverTitle", cover.getCoverTitle() );
assertEquals( "coverType", cover.getCoverType() );
assertEquals( "coverVersion", cover.getCoverVersion() );
assertEquals( "projectLogo", cover.getProjectLogo() );
assertEquals( "projectName", cover.getProjectName() );
}
private DocumentStatistic getDocumentStatistic()
{
DocumentStatistic statistic = new DocumentStatistic();
statistic.setCharacterCount( 2L );
statistic.setDrawCount( 3L );
statistic.setFrameCount( 4L );
statistic.setImageCount( 5L );
statistic.setNonWhitespaceCharacterCount( 6L );
statistic.setObjectCount( 1L );
statistic.setOleObjectCount( 8L );
statistic.setPageCount( 7L );
statistic.setParagraphCount( 5L );
statistic.setRowCount( 6L );
statistic.setSentenceCount( 3L );
statistic.setSyllableCount( 10L );
statistic.setTableCount( 2L );
statistic.setWordCount( 11L );
return statistic;
}
private void verifyDocumentStatistic( DocumentStatistic documentStatistic )
{
assertEquals( 2L, documentStatistic.getCharacterCount() );
assertEquals( 3L, documentStatistic.getDrawCount() );
assertEquals( 4L, documentStatistic.getFrameCount() );
assertEquals( 5L, documentStatistic.getImageCount() );
assertEquals( 6L, documentStatistic.getNonWhitespaceCharacterCount() );
assertEquals( 1L, documentStatistic.getObjectCount() );
assertEquals( 8L, documentStatistic.getOleObjectCount() );
assertEquals( 7L, documentStatistic.getPageCount() );
assertEquals( 5L, documentStatistic.getParagraphCount() );
assertEquals( 6L, documentStatistic.getRowCount() );
assertEquals( 3L, documentStatistic.getSentenceCount() );
assertEquals( 10L, documentStatistic.getSyllableCount() );
assertEquals( 2L, documentStatistic.getTableCount() );
assertEquals( 11L, documentStatistic.getWordCount() );
}
private DocumentHyperlinkBehaviour getDocumentHyperlinkBehaviour()
{
DocumentHyperlinkBehaviour hylink = new DocumentHyperlinkBehaviour();
hylink.setTargetFrame( "targetFrame" );
return hylink;
}
private void verifyDocumentHyperlinkBehaviour( DocumentHyperlinkBehaviour hyperlinkBehaviour )
{
assertEquals( "targetFrame", hyperlinkBehaviour.getTargetFrame() );
}
private DocumentMeta getDocumentMeta()
{
DocumentMeta meta = new DocumentMeta();
meta.setAuthor( "author" );
meta.addAuthor( getAuthor( 2 ) );
meta.setConfidential( true );
meta.setCreationDate( new Date( 1L ) );
meta.setCreator( "creator" );
meta.setDate( new Date( 2L ) );
meta.setDescription( "description" );
meta.setDocumentStatistic( getDocumentStatistic() );
meta.setDraft( true );
meta.setEditingCycles( 15L );
meta.setEditingDuration( 3L );
meta.setGenerator( "generator" );
meta.setHyperlinkBehaviour( getDocumentHyperlinkBehaviour() );
meta.setInitialCreator( "initialCreator" );
meta.addKeyWord( "keyword1" );
meta.addKeyWord( "keyword2" );
meta.setLanguage( "language" );
meta.setPageSize( "pageSize" );
meta.setPrintDate( new Date( 4L ) );
meta.setPrintedBy( "printedBy" );
meta.setSubject( "subject" );
meta.setTemplate( getDocumentTemplate() );
meta.setTitle( "title" );
return meta;
}
private void verifyDocumentMeta( DocumentMeta meta )
{
assertEquals( "author", meta.getAuthor() );
List authors = meta.getAuthors();
assertEquals( 1, authors.size() );
verifyAuthor( (DocumentAuthor) authors.get( 0 ), 2 );
assertTrue( meta.isConfidential() );
assertEquals( 1L, meta.getCreationDate().getTime() );
assertEquals( "creator", meta.getCreator() );
assertEquals( 2L, meta.getDate().getTime() );
assertEquals( "description", meta.getDescription() );
verifyDocumentStatistic( meta.getDocumentStatistic() );
assertTrue( meta.isDraft() );
assertEquals( 15L, meta.getEditingCycles() );
assertEquals( 3L, meta.getEditingDuration() );
assertEquals( "generator", meta.getGenerator() );
verifyDocumentHyperlinkBehaviour( meta.getHyperlinkBehaviour() );
assertEquals( "initialCreator", meta.getInitialCreator() );
assertEquals( "keyword1, keyword2", meta.getAllKeyWords() );
assertEquals( "language", meta.getLanguage() );
assertEquals( "pageSize", meta.getPageSize() );
assertEquals( 4L, meta.getPrintDate().getTime() );
assertEquals( "printedBy", meta.getPrintedBy() );
assertEquals( "subject", meta.getSubject() );
verifyDocumentTemplate( meta.getTemplate() );
assertEquals( "title", meta.getTitle() );
}
private DocumentTemplate getDocumentTemplate()
{
DocumentTemplate template = new DocumentTemplate();
template.setDate( new Date( 3L ) );
template.setHref( "href" );
template.setTitle( "title" );
return template;
}
private void verifyDocumentTemplate( DocumentTemplate template )
{
assertEquals( 3L, template.getDate().getTime() );
assertEquals( "href", template.getHref() );
assertEquals( "title", template.getTitle() );
}
private DocumentTOC getDocumentToc()
{
DocumentTOCItem item1 = new DocumentTOCItem();
item1.setName( "First document" );
item1.setRef( "doc1.apt" );
DocumentTOCItem item2 = new DocumentTOCItem();
item2.setName( "Second document" );
item2.setRef( "doc2.xml" );
DocumentTOC toc = new DocumentTOC();
toc.setName( "name" );
toc.addItem( item1 );
toc.addItem( item2 );
return toc;
}
private void verifyDocumentTOC( DocumentTOC toc )
{
assertEquals( "name", toc.getName() );
}
private DocumentModel writeAndRecover( DocumentModel model )
throws IOException
{
File dir = getTestFile( "target/test-output/xpp3/" );
if ( !dir.exists() )
{
dir.mkdirs();
}
File testFile = getTestFile( dir.getAbsolutePath(), "testModel.xml" );
Writer w = null;
try
{
w = WriterFactory.newXmlWriter( testFile );
new DocumentXpp3Writer().write( w, model );
}
finally
{
IOUtil.close( w );
}
DocumentModel documentModel;
Reader reader = null;
try
{
reader = ReaderFactory.newXmlReader( testFile );
documentModel = new DocumentXpp3Reader().read( reader );
}
catch ( XmlPullParserException e )
{
throw (IOException) new IOException( "Error parsing document descriptor" ).initCause( e );
}
finally
{
IOUtil.close( reader );
}
return documentModel;
}
} doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/util/ 0000755 0001750 0001750 00000000000 11632765553 024514 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/util/DoxiaUtilsTest.java 0000644 0001750 0001750 00000021326 11211316077 030272 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.text.ParseException;
import java.util.Date;
import java.util.GregorianCalendar;
import org.codehaus.plexus.PlexusTestCase;
/**
* Test case for DoxiaUtils.
*
* @author ltheussl
* @version $Id: DoxiaUtilsTest.java 781180 2009-06-02 21:40:15Z vsiveton $
*/
public class DoxiaUtilsTest
extends PlexusTestCase
{
/**
* Verify the expected results.
*/
public void testIsInternalLink()
{
String link = "#anchor";
assertTrue( "Should be an internal link: " + link,
DoxiaUtils.isInternalLink( link ) );
link = "http://maven.apache.org/index.html#anchor";
assertFalse( "Should NOT be an internal link: " + link,
DoxiaUtils.isInternalLink( link ) );
link = "./index.html";
assertFalse( "Should NOT be an internal link: " + link,
DoxiaUtils.isInternalLink( link ) );
}
/**
* Verify the expected results.
*/
public void testIsExternalLink()
{
String link = "http://maven.apache.org/";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "https://maven.apache.org/";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "HTTPS://MAVEN.APACHE.ORG/";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "ftp:/maven.apache.org/";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "mailto:maven@apache.org";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "file:/index.html";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "resource_type://domain:port/filepathname?query_string#anchor";
assertTrue( "Should be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "index.html";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "example.pdf";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "./index.html";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "../index.html";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
// Windows style separators "\" are not allowed
link = "file:\\index.html";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = ".\\index.html";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
link = "..\\index.html";
assertFalse( "Should NOT be an external link: " + link,
DoxiaUtils.isExternalLink( link ) );
}
/**
* Verify the expected results.
*/
public void testIsLocalLink()
{
String link = "index.html";
assertTrue( "Should be a local link: " + link,
DoxiaUtils.isLocalLink( link ) );
link = "./index.html";
assertTrue( "Should be a local link: " + link,
DoxiaUtils.isLocalLink( link ) );
link = "../index.html";
assertTrue( "Should be a local link: " + link,
DoxiaUtils.isLocalLink( link ) );
link = "#anchor";
assertFalse( "Should NOT be a local link: " + link,
DoxiaUtils.isLocalLink( link ) );
link = "http://maven.apache.org/";
assertFalse( "Should NOT be a local link: " + link,
DoxiaUtils.isLocalLink( link ) );
}
/**
* Verify the expected results.
*/
public void testEncodeId()
{
assertEquals( DoxiaUtils.encodeId( null ), null );
assertEquals( DoxiaUtils.encodeId( "" ), "a" );
assertEquals( DoxiaUtils.encodeId( " " ), "a" );
assertEquals( DoxiaUtils.encodeId( " _ " ), "a_" );
assertEquals( DoxiaUtils.encodeId( "1" ), "a1" );
assertEquals( DoxiaUtils.encodeId( "1anchor" ), "a1anchor" );
assertEquals( DoxiaUtils.encodeId( "_anchor" ), "a_anchor" );
assertEquals( DoxiaUtils.encodeId( "a b-c123 " ), "a_b-c123" );
assertEquals( DoxiaUtils.encodeId( " anchor" ), "anchor" );
assertEquals( DoxiaUtils.encodeId( "myAnchor" ), "myAnchor" );
assertEquals( DoxiaUtils.encodeId( "my&Anchor" ), "my%26Anchor" );
assertEquals( DoxiaUtils.encodeId( "H\u00E5kon" ), "H%c3%a5kon" );
assertEquals( DoxiaUtils.encodeId( "H\u00E5kon", true ), "Hkon" );
assertEquals( DoxiaUtils.encodeId( "Theu\u00DFl" ), "Theu%c3%9fl" );
assertEquals( DoxiaUtils.encodeId( "Theu\u00DFl", true ), "Theul" );
}
/**
* Verify the expected results.
*/
public void testIsValidId()
{
assertFalse( DoxiaUtils.isValidId( null ) );
assertFalse( DoxiaUtils.isValidId( "" ) );
assertFalse( DoxiaUtils.isValidId( " " ) );
assertFalse( DoxiaUtils.isValidId( " _ " ) );
assertFalse( DoxiaUtils.isValidId( "1" ) );
assertFalse( DoxiaUtils.isValidId( "1anchor" ) );
assertFalse( DoxiaUtils.isValidId( "_anchor" ) );
assertFalse( DoxiaUtils.isValidId( "a b-c123 " ) );
assertFalse( DoxiaUtils.isValidId( " anchor" ) );
assertFalse( DoxiaUtils.isValidId( "my&Anchor" ) );
assertTrue( DoxiaUtils.isValidId( "myAnchor" ) );
assertTrue( DoxiaUtils.isValidId( "a_" ) );
assertTrue( DoxiaUtils.isValidId( "a-" ) );
assertTrue( DoxiaUtils.isValidId( "a:" ) );
assertTrue( DoxiaUtils.isValidId( "a." ) );
assertTrue( DoxiaUtils.isValidId( "index.html" ) );
assertFalse( DoxiaUtils.isValidId( "Theu\u00DFl" ) );
}
/**
* Verify the expected results.
*/
public void testParseDate()
{
final int year = 1973;
final int month = 1;
final int day = 27;
try
{
final Date feb27 = new GregorianCalendar( year, month, day ).getTime();
assertEquals( feb27, DoxiaUtils.parseDate( "27.02.1973" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "27. 02. 1973" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "1973-02-27" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "1973/02/27" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "27 Feb 1973" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "27 Feb. 1973" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "Feb. 27, 1973" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "Feb 27, '73" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "February 27, 1973" ) );
assertEquals( feb27, DoxiaUtils.parseDate( "19730227" ) );
assertEquals( new GregorianCalendar( year, 0, 1 ).getTime(), DoxiaUtils.parseDate( "1973" ) );
final Date feb1 = new GregorianCalendar( year, 1, 1 ).getTime();
assertEquals( feb1, DoxiaUtils.parseDate( "February 1973" ) );
assertEquals( feb1, DoxiaUtils.parseDate( "Feb. 1973" ) );
assertEquals( feb1, DoxiaUtils.parseDate( "February '73" ) );
assertEquals( feb1, DoxiaUtils.parseDate( "Feb. '73" ) );
assertNotNull( DoxiaUtils.parseDate( "Today" ) );
assertNotNull( DoxiaUtils.parseDate( "NOW" ) );
}
catch ( ParseException ex )
{
fail( ex.getMessage() );
}
try
{
DoxiaUtils.parseDate( "yesterday" ).getTime();
fail();
}
catch ( ParseException ex )
{
assertNotNull( ex );
}
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/util/ByLineReaderSourceTest.java 0000644 0001750 0001750 00000003642 10767707462 031715 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import org.apache.maven.doxia.parser.ParseException;
import junit.framework.TestCase;
/**
* Unit test for {@link org.apache.maven.doxia.util.ByLineReaderSource}.
*
* @author Juan F. Codagnone
* @since Nov 1, 2005
*/
public class ByLineReaderSourceTest extends TestCase
{
/**
* @throws ParseException on error
*/
public final void testUse() throws ParseException
{
ByLineReaderSource r = new ByLineReaderSource(
new StringReader( "1 \n2\n3" ) );
assertEquals( -1, r.getLineNumber() );
assertEquals( "", r.getName() );
assertEquals( "1 ", r.getNextLine() );
assertEquals( "2", r.getNextLine() );
r.ungetLine();
assertEquals( "2", r.getNextLine() );
r.ungetLine();
try
{
r.ungetLine();
fail();
}
catch ( IllegalStateException e )
{
// ok;
}
assertEquals( "2", r.getNextLine() );
assertEquals( "3", r.getNextLine() );
assertEquals( null, r.getNextLine() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/util/HtmlToolsTest.java 0000644 0001750 0001750 00000015262 11206736532 030142 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.net.URLEncoder;
import java.util.Locale;
import org.codehaus.plexus.PlexusTestCase;
/**
* Test case for HtmlTools.
*
* @author Vincent Siveton
* @version $Id: HtmlToolsTest.java 778640 2009-05-26 09:58:50Z vsiveton $
*/
public class HtmlToolsTest
extends PlexusTestCase
{
/**
* Verify the expected results.
*/
public void testEscapeHTML()
{
assertEquals( HtmlTools.escapeHTML( null ), "" );
assertEquals( HtmlTools.escapeHTML( "" ), "" );
assertEquals( HtmlTools.escapeHTML( "\u0009" ), "\u0009" );
assertEquals( HtmlTools.escapeHTML( "\u0001" ), "\u0001" );
// Predefined entities
assertEquals( HtmlTools.escapeHTML( "<" ), "<" );
assertEquals( HtmlTools.escapeHTML( ">" ), ">" );
assertEquals( HtmlTools.escapeHTML( "&" ), "&" );
assertEquals( HtmlTools.escapeHTML( "\"" ), """ );
assertEquals( HtmlTools.escapeHTML( "\'" ), "'" );
assertEquals( HtmlTools.escapeHTML( "\'", false ), "\'" );
// xml mode
assertEquals( HtmlTools.escapeHTML( "&" ), "&" );
assertEquals( HtmlTools.escapeHTML( "\u00e4", true ), "\u00e4" );
assertEquals( HtmlTools.escapeHTML( "\u00e4", false ), "ä" );
assertEquals( HtmlTools.escapeHTML( "\u0159", false ), "ř" );
assertEquals( HtmlTools.escapeHTML( "\uD835\uDFED", false ), "𝟭" );
}
/**
* Verify the expected results.
*/
public void testUnescapeHTML()
{
assertNull( HtmlTools.unescapeHTML( null ) );
assertEquals( "", HtmlTools.unescapeHTML( "" ) );
assertEquals( "\u0009", HtmlTools.unescapeHTML( "\u0009" ) );
assertEquals( "\u0001", HtmlTools.unescapeHTML( "\u0001" ) );
assertEquals( "<", HtmlTools.unescapeHTML( "<" ) );
assertEquals( ">", HtmlTools.unescapeHTML( ">" ) );
assertEquals( "&", HtmlTools.unescapeHTML( "&" ) );
assertEquals( "\"", HtmlTools.unescapeHTML( """ ) );
assertEquals( "'", HtmlTools.unescapeHTML( "'" ) );
assertEquals( "\'", HtmlTools.unescapeHTML( "'", true ) );
assertEquals( "&", HtmlTools.unescapeHTML( "&" ) );
assertEquals( "<Français>", HtmlTools.unescapeHTML( "<Français>" ) );
assertEquals( "\u0159", HtmlTools.unescapeHTML( "ř" ) );
assertEquals( "\uD808\uDF45", HtmlTools.unescapeHTML( "𒍅" ) );
assertEquals( "\uD835\uDFED", HtmlTools.unescapeHTML( "𝟭" ) );
assertEquals( "\uD808\uDF45\uD835\uDFED", HtmlTools.unescapeHTML( "𒍅𝟭" ) );
assertEquals( "𝟭 𝟭", HtmlTools.unescapeHTML( "𝟭 𝟭" ) );
assertEquals( "𝟭 \uD835\uDFED", HtmlTools.unescapeHTML( "𝟭 𝟭" ) );
assertEquals( "&#xQWER;", HtmlTools.unescapeHTML( "&#xQWER;" ) );
assertEquals( "\u00E5", HtmlTools.unescapeHTML( "å" ) );
assertEquals( "<>&\"\u00E5\u0159\uD835\uDFED",
HtmlTools.unescapeHTML( "<>&"åř𝟭" ) );
}
/**
* Verify the expected results.
*/
public void testEncodeId()
{
assertEquals( HtmlTools.encodeId( null ), null );
assertEquals( HtmlTools.encodeId( "" ), "a" );
assertEquals( HtmlTools.encodeId( " " ), "a" );
assertEquals( HtmlTools.encodeId( " _ " ), "a_" );
assertEquals( HtmlTools.encodeId( "1" ), "a1" );
assertEquals( HtmlTools.encodeId( "1anchor" ), "a1anchor" );
assertEquals( HtmlTools.encodeId( "_anchor" ), "a_anchor" );
assertEquals( HtmlTools.encodeId( "a b-c123 " ), "a_b-c123" );
assertEquals( HtmlTools.encodeId( " anchor" ), "anchor" );
assertEquals( HtmlTools.encodeId( "myAnchor" ), "myAnchor" );
assertEquals( HtmlTools.encodeId( "H\u00E5kon" ), "Hkon" );
assertEquals( HtmlTools.encodeId( "Theu\u00DFl" ), "Theul" );
}
/**
* Verify the expected results.
*/
public void testEncodeURL()
throws Exception
{
assertNull( HtmlTools.encodeURL( null ) );
assertEquals( HtmlTools.encodeURL( "" ), "" );
assertEquals( HtmlTools.encodeURL( "http://www.example.com/?This is a simple test." ),
"http://www.example.com/?This%20is%20a%20simple%20test." );
assertEquals( HtmlTools.encodeURL( "http://www.example.com/?This is a simple & short test." ),
"http://www.example.com/?This%20is%20a%20simple%20&%20short%20test." );
String url = "\uD808\uDF45";
assertEquals( HtmlTools.encodeURL( url ), URLEncoder.encode( url, "UTF-8" ).toLowerCase( Locale.ENGLISH ) );
}
/**
* Verify the expected results.
*/
public void testIsId()
{
assertFalse( HtmlTools.isId( null ) );
assertFalse( HtmlTools.isId( "" ) );
assertFalse( HtmlTools.isId( " " ) );
assertFalse( HtmlTools.isId( " _ " ) );
assertFalse( HtmlTools.isId( "1" ) );
assertFalse( HtmlTools.isId( "1anchor" ) );
assertFalse( HtmlTools.isId( "_anchor" ) );
assertFalse( HtmlTools.isId( "a b-c123 " ) );
assertFalse( HtmlTools.isId( " anchor" ) );
assertTrue( HtmlTools.isId( "myAnchor" ) );
assertTrue( HtmlTools.isId( "a_" ) );
assertTrue( HtmlTools.isId( "a-" ) );
assertTrue( HtmlTools.isId( "a:" ) );
assertTrue( HtmlTools.isId( "a." ) );
assertFalse( HtmlTools.isId( "Theu\u00DFl" ) );
}
/**
* Verify the expected results.
*/
public void testGetHtmlTag()
{
assertNull( HtmlTools.getHtmlTag( "" ) );
assertNull( HtmlTools.getHtmlTag( "weirdHtmlTag" ) );
assertNotNull( HtmlTools.getHtmlTag( "strong" ) );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765553 025024 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/module/AbstractIdentityTest.java 0000644 0001750 0001750 00000012704 11207760055 031776 0 ustar twerner twerner package org.apache.maven.doxia.module;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.Writer;
import org.apache.maven.doxia.AbstractModuleTest;
import org.apache.maven.doxia.logging.PlexusLoggerWrapper;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkTestDocument;
import org.apache.maven.doxia.sink.TextSink;
import org.codehaus.plexus.util.IOUtil;
/**
* If a module provides both Parser and Sink, this class
* can be used to check that chaining them together
* results in the identity transformation, ie the model is still the same
* after being piped through a Parser and the corresponding Sink.
*
* @version $Id: AbstractIdentityTest.java 779957 2009-05-29 13:16:29Z vsiveton $
*/
public abstract class AbstractIdentityTest
extends AbstractModuleTest
{
/** Expected Identity String */
private String expected;
/**
* Set to true if the identity transformation should actually be asserted,
* by default only the expected and actual results are written to a file, but not compared.
*/
private boolean assertIdentity;
/**
* Create a new instance of the parser to test.
*
* @return the parser to test.
*/
protected abstract Parser createParser();
/**
* Return a new instance of the sink that is being tested.
*
* @param writer The writer for the sink.
* @return A new sink.
*/
protected abstract Sink createSink( Writer writer );
/**
* Pipes a full model generated by {@link SinkTestDocument} through
* a Sink (generated by {@link #createSink(Writer)}) and a Parser
* (generated by {@link #createParser()}) and checks if the result
* is the same as the original model. By default, this doesn't actually
* assert anything (use {@link #assertIdentity(boolean)} in the setUp()
* of an implementation to switch on the test), but the two generated
* output files, expected.txt and actual.txt, can be compared for differences.
*
* @throws IOException if there's a problem reading/writing a test file.
* @throws ParseException if a model cannot be parsed.
*/
public void testIdentity()
throws IOException, ParseException
{
// generate the expected model
StringWriter writer = new StringWriter();
Sink sink = new TextSink( writer );
SinkTestDocument.generate( sink );
sink.close();
expected = writer.toString();
// write to file for comparison
Writer fileWriter = getTestWriter( "expected" );
fileWriter.write( expected );
IOUtil.close( fileWriter );
// generate the actual model
writer = new StringWriter();
sink = createSink( writer );
SinkTestDocument.generate( sink );
sink.close();
StringReader reader = new StringReader( writer.toString() );
writer = new StringWriter();
sink = new TextSink( writer );
Parser parser = createParser();
parser.enableLogging( new PlexusLoggerWrapper( getContainer().getLogger() ) );
parser.parse( reader, sink );
String actual = writer.toString();
// write to file for comparison
fileWriter = getTestWriter( "actual" );
fileWriter.write( actual );
IOUtil.close( fileWriter );
// Disabled by default, it's unlikely that all our modules
// will pass this test any time soon, but the generated
// output files can still be compared.
if ( assertIdentity )
{
// TODO: make this work for at least apt and xdoc modules?
assertEquals( "Identity test failed!", getExpected(), actual );
}
}
/** {@inheritDoc} */
protected String getOutputDir()
{
return "identity/";
}
/**
* The output files generated by this class are text files,
* independend of the kind of module being tested.
*
* @return The String "txt".
*/
protected String outputExtension()
{
return "txt";
}
/**
* Set to true if the identity transformation should actually be asserted,
* by default only the expected and actual results are written to a file, but not compared.
* This should be called during setUp().
*
* @param doAssert True to actually execute the test.
*/
protected void assertIdentity( boolean doAssert )
{
this.assertIdentity = doAssert;
}
/**
* @return the expected identity string
*/
protected String getExpected()
{
return expected;
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/AbstractModuleTest.java 0000644 0001750 0001750 00000015454 11105660512 030144 0 ustar twerner twerner package org.apache.maven.doxia;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.markup.Markup;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.WriterFactory;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.Writer;
/**
* Provide some common convenience methods to test Doxia modules (parsers and sinks).
*
* @version $Id: AbstractModuleTest.java 712574 2008-11-09 22:16:42Z hboutemy $
* @since 1.0
*/
public abstract class AbstractModuleTest
extends PlexusTestCase
implements Markup
{
/**
* Set the system properties:
*
*
line.separator to \n (Unix) to prevent
* failure on windows.
*
*/
static
{
// Safety
System.setProperty( "line.separator", "\n" );
}
// ----------------------------------------------------------------------
// Methods for creating test reader and writer
// ----------------------------------------------------------------------
/**
* Returns a FileWriter to write to a file with the given name
* in the test target output directory.
*
* @param baseName The name of the target file.
* @param extension The file extension of the file to write.
* @return A FileWriter.
* @throws IOException If the FileWriter could not be generated.
* @see WriterFactory#newWriter(File, String)
*/
protected Writer getTestWriter( String baseName, String extension )
throws IOException
{
File outputDirectory =
new File( getBasedirFile(), outputBaseDir() + getOutputDir() );
if ( !outputDirectory.exists() )
{
outputDirectory.mkdirs();
}
return WriterFactory.newWriter( new File( outputDirectory, baseName + "." + extension ), "UTF-8" );
}
/**
* Returns an XML FileWriter to write to a file with the given name
* in the test target output directory.
*
* @param baseName The name of the target file.
* @return An XML FileWriter.
* @throws IOException If the FileWriter could not be generated.
* @see #getXmlTestWriter(String, String)
*/
protected Writer getXmlTestWriter( String baseName )
throws IOException
{
return getXmlTestWriter( baseName, outputExtension() );
}
/**
* Returns an XML FileWriter to write to a file with the given name
* in the test target output directory.
*
* @param baseName The name of the target file.
* @param extension The file extension of the file to write.
* @return An XML FileWriter.
* @throws IOException If the FileWriter could not be generated.
* @see WriterFactory#newXmlWriter(File)
*/
protected Writer getXmlTestWriter( String baseName, String extension )
throws IOException
{
File outputDirectory =
new File( getBasedirFile(), outputBaseDir() + getOutputDir() );
if ( !outputDirectory.exists() )
{
outputDirectory.mkdirs();
}
return WriterFactory.newXmlWriter(
new File( outputDirectory, baseName + "." + extension ) );
}
/**
* Returns a FileWriter to write to a file with the given name
* in the test target output directory.
*
* @param baseName The name of the target file.
* @return A FileWriter.
* @throws IOException If the FileWriter could not be generated.
* @see #getTestWriter(String, String)
*/
protected Writer getTestWriter( String baseName )
throws IOException
{
return getTestWriter( baseName, outputExtension() );
}
/**
* Returns an InputStreamReader to read a resource from a file
* in the test target output directory.
*
* @param baseName The name of the resource file to read.
* @param extension The file extension of the resource file to read.
* @return An InputStreamReader.
*/
protected Reader getTestReader( String baseName, String extension )
{
InputStream is =
Thread.currentThread().getContextClassLoader().getResourceAsStream(
baseName + "." + extension );
assertNotNull( "Could not find resource: "
+ baseName + "." + extension, is );
InputStreamReader reader = new InputStreamReader( is );
return reader;
}
/**
* Returns an InputStreamReader to read a resource from a file
* in the test target output directory.
*
* @param baseName The name of the resource file to read.
* @return An InputStreamReader.
* @see #getTestReader(String, String)
*/
protected Reader getTestReader( String baseName )
{
return getTestReader( baseName, outputExtension() );
}
// ----------------------------------------------------------------------
// Utility methods
// ----------------------------------------------------------------------
/**
* Returns the common base directory.
*
* @return The common base directory as a File.
*/
protected File getBasedirFile()
{
return new File( getBasedir() );
}
/**
* Returns the base directory where all test output will go.
*
* @return The test output directory.
*/
protected final String outputBaseDir()
{
return "target/test-output/";
}
// ----------------------------------------------------------------------
// Abstract methods the individual ModuleTests must provide
// ----------------------------------------------------------------------
/**
* Determines the default file extension for the current module.
*
* @return The default file extension.
*/
protected abstract String outputExtension();
/**
* Returns the directory where test output will go.
* Should be relative to outputBaseDir().
*
* @return The test output directory, relative to outputBaseDir().
*/
protected abstract String getOutputDir();
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/parser/ 0000755 0001750 0001750 00000000000 11632765553 025033 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/parser/XhtmlBaseParserTest.java 0000644 0001750 0001750 00000073362 11313470726 031604 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Iterator;
import org.apache.maven.doxia.logging.Log;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventElement;
import org.apache.maven.doxia.sink.SinkEventTestingSink;
import org.codehaus.plexus.PlexusTestCase;
/**
* Test for XhtmlBaseParser.
*
* @author ltheussl
* @version $Id: XhtmlBaseParserTest.java 892639 2009-12-20 18:49:58Z ltheussl $
* @since 1.1
*/
public class XhtmlBaseParserTest
extends PlexusTestCase
{
private XhtmlBaseParser parser;
private final SinkEventTestingSink sink = new SinkEventTestingSink();
/** {@inheritDoc} */
protected void setUp() throws Exception
{
super.setUp();
parser = new XhtmlBaseParser();
parser.getLog().setLogLevel( Log.LEVEL_ERROR );
sink.reset();
}
/** {@inheritDoc} */
protected void tearDown() throws Exception
{
super.tearDown();
}
/** @throws Exception */
public void testHeadingEventsList()
throws Exception
{
String text = "";
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "paragraph", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section2", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle2", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle2_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section3", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle3", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle3_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section4", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle4", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle4_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section5", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle5", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle5_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section5_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section4_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section3_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section2_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "section1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "sectionTitle1_", ( (SinkEventElement) it.next() ).getName() );
// this one is missing because we enclose everything in
which is not valid xhtml,
// needs to be tested in overriding parser, eg XhtmlParser, XdocParser.
//assertEquals( "section1_", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "paragraph_", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
}
/** @throws Exception */
public void testNestedHeadingEventsList()
throws Exception
{
// DOXIA-241
String text = "
";
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
SinkEventElement element = (SinkEventElement) it.next();
assertEquals( "link", element.getName() );
assertEquals( "", element.getArgs()[0] );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "link", element.getName() );
assertEquals( "valid", element.getArgs()[0] );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "link", element.getName() );
assertEquals( "#a1invalid", element.getArgs()[0] );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "link", element.getName() );
assertEquals( "http://www.fo.com/index.html#1invalid", element.getArgs()[0] );
assertEquals( "link_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "anchor", element.getName() );
assertEquals( "valid", element.getArgs()[0] );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "anchor", element.getName() );
assertEquals( "a1invalid", element.getArgs()[0] );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
element = (SinkEventElement) it.next();
assertEquals( "anchor", element.getName() );
assertEquals( "a1invalid", element.getArgs()[0] );
assertEquals( "anchor_", ( (SinkEventElement) it.next() ).getName() );
}
/**
* Test entities in attributes.
*
* @throws java.lang.Exception if any.
*/
public void testAttributeEntities()
throws Exception
{
String text = "";
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
SinkEventElement event = (SinkEventElement) it.next();
assertEquals( "unknown", event.getName() );
assertEquals( "script", event.getArgs()[0] );
SinkEventAttributeSet attribs = (SinkEventAttributeSet) event.getArgs()[2];
// ampersand should be un-escaped
assertEquals( "http://ex.com/ex.js?v=l&l=e", attribs.getAttribute( "src" ) );
assertEquals( "unknown", ( (SinkEventElement) it.next() ).getName() );
assertFalse( it.hasNext() );
sink.reset();
text = "";
parser.parse( text, sink );
it = sink.getEventList().iterator();
event = (SinkEventElement) it.next();
assertEquals( "figureGraphics", event.getName() );
attribs = (SinkEventAttributeSet) event.getArgs()[1];
// ampersand should be un-escaped
assertEquals( "http://ex.com/ex.jpg?v=l&l=e", attribs.getAttribute( "src" ) );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java 0000644 0001750 0001750 00000004414 11151220275 032234 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkAdapter;
import org.codehaus.plexus.PlexusTestCase;
import java.io.FileReader;
import java.io.Reader;
/**
* Test the parsing of sample input files
*
* @author Carlos Sanchez
* @author Emmanuel Venisse
* @version $Id: AbstractParserTestCase.java 747735 2009-02-25 10:43:09Z ltheussl $
* @since 1.0
*/
public abstract class AbstractParserTestCase
extends PlexusTestCase
{
/**
* Parser to use to convert input to sink events
*
* @return the parser to use
*/
protected abstract Parser getParser();
/**
* Path of the model to test, relative to basedir
*
* @return the relative path
*/
protected abstract String getDocument();
/**
* Sink to write the output of the parsing
*
* @return a SinkAdapter if not overridden
*/
protected Sink getSink()
{
return new SinkAdapter();
}
/**
* Parse the model in the path specified by {@link #getDocument()},
* with parser from {@link #getParser()}, and output to sink from {@link #getSink()}
*
* @throws Exception if any.
*/
public void testParser()
throws Exception
{
Reader reader = new FileReader( getTestFile( getBasedir(), getDocument() ) );
getParser().parse( reader, getSink() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTest.java 0000644 0001750 0001750 00000007170 11134645700 031447 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.AbstractModuleTest;
import org.apache.maven.doxia.sink.WellformednessCheckingSink;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.TextSink;
import org.codehaus.plexus.util.IOUtil;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
/**
* Test the parsing of sample input files.
*
* Note: you have to provide a sample "test." + outputExtension()
* file in the test resources directory if you extend this class.
*
* @version $Id: AbstractParserTest.java 735474 2009-01-18 15:33:20Z vsiveton $
* @since 1.0
*/
public abstract class AbstractParserTest
extends AbstractModuleTest
{
/**
* Create a new instance of the parser to test.
*
* @return the parser to test.
*/
protected abstract Parser createParser();
/**
* Returns the directory where all parser test output will go.
*
* @return The test output directory.
*/
protected String getOutputDir()
{
return "parser/";
}
/**
* Parse a test document '"test." + outputExtension()'
* with parser from {@link #createParser()}, and output to a new
* {@link WellformednessCheckingSink}. Asserts that output is well-formed.
*
* @throws IOException if the test document cannot be read.
* @throws ParseException if the test document cannot be parsed.
*/
public final void testParser()
throws IOException, ParseException
{
WellformednessCheckingSink sink = new WellformednessCheckingSink();
Reader reader = null;
try
{
reader = getTestReader( "test", outputExtension() );
createParser().parse( reader, sink );
assertTrue( "Parser output not well-formed, last offending element: "
+ sink.getOffender(), sink.isWellformed() );
}
finally
{
IOUtil.close( reader );
}
}
/**
* Parse a test document '"test." + outputExtension()'
* with parser from {@link #createParser()}, and output to a text file,
* using the {@link org.apache.maven.doxia.sink.TextSink TextSink}.
*
* @throws IOException if the test document cannot be read.
* @throws ParseException if the test document cannot be parsed.
*/
public final void testDocument()
throws IOException, ParseException
{
Writer writer = null;
Reader reader = null;
try
{
writer = getTestWriter( "test", "txt" );
reader = getTestReader( "test", outputExtension() );
Sink sink = new TextSink( writer );
createParser().parse( reader, sink );
}
finally
{
IOUtil.close( reader );
IOUtil.close( writer );
}
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/ 0000755 0001750 0001750 00000000000 11632765553 024503 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractXmlSinkTest.java 0000644 0001750 0001750 00000010264 11166632332 031250 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Tag;
import junit.framework.TestCase;
/**
*
* @author ltheussl
*/
public class AbstractXmlSinkTest
extends TestCase
{
/**
* Test of set/getNameSpace method, of class AbstractXmlSink.
*/
public void testNameSpace()
{
final Tag t = Tag.A;
final String ns = "ns";
final XmlTestSink instance = new XmlTestSink();
instance.writeStartTag( t );
instance.writeEndTag( t );
assertEquals( "", instance.getText() );
instance.writeSimpleTag( t );
assertEquals( "", instance.getText() );
instance.setNameSpace( ns );
instance.writeStartTag( t );
instance.writeEndTag( t );
assertEquals( "", instance.getText() );
instance.writeSimpleTag( t );
assertEquals( "", instance.getText() );
assertEquals( ns, instance.getNameSpace() );
try
{
instance.writeStartTag( null );
fail( "null tag should fail!" );
}
catch ( IllegalArgumentException e )
{
assertNotNull( e );
}
try
{
instance.writeEndTag( null );
fail( "null tag should fail!" );
}
catch ( IllegalArgumentException e )
{
assertNotNull( e );
}
}
/**
* Test of writeStartTag method, of class AbstractXmlSink.
*/
public void testWriteStartTag()
{
final Tag t = Tag.A;
final SinkEventAttributes att = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
final XmlTestSink instance = new XmlTestSink();
instance.writeStartTag( t );
assertEquals( "", instance.getText() );
instance.writeStartTag( t, att );
assertEquals( "", instance.getText() );
instance.writeStartTag( t, att, false );
assertEquals( "", instance.getText() );
instance.writeStartTag( t, att, true );
assertEquals( "", instance.getText() );
}
/**
* Test of writeEOL method, of class AbstractXmlSink.
*/
public void testWriteEOL()
{
final XmlTestSink instance = new XmlTestSink();
instance.writeEOL();
assertEquals( System.getProperty( "line.separator" ), instance.getText() );
}
/**
* Test of writeSimpleTag method, of class AbstractXmlSink.
*/
public void testWriteSimpleTag()
{
final Tag t = Tag.A;
final SinkEventAttributes att = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
final XmlTestSink instance = new XmlTestSink();
instance.writeSimpleTag( t );
assertEquals( "", instance.getText() );
instance.writeSimpleTag( t, att );
assertEquals( "", instance.getText() );
}
/** Test sink. */
private class XmlTestSink
extends AbstractXmlSink
{
private final StringBuffer buffer = new StringBuffer( 0 );
public void reset()
{
buffer.setLength( 0 );
}
public String getText()
{
String text = buffer.toString();
reset();
return text;
}
protected void write( String text )
{
buffer.append( text );
}
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/SinkAdapterTest.java 0000644 0001750 0001750 00000031145 11163507633 030407 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import junit.framework.TestCase;
/**
*
* @author ltheussl
*/
public class SinkAdapterTest
extends TestCase
{
private final SinkAdapter instance = new SinkAdapter();
/**
* Test of head method, of class SinkAdapter.
*/
public void testHead()
{
instance.head();
instance.head( null );
instance.head_();
}
/**
* Test of body method, of class SinkAdapter.
*/
public void testBody()
{
instance.body();
instance.body( null );
instance.body_();
}
/**
* Test of section1 method, of class SinkAdapter.
*/
public void testSection1()
{
final int level = SinkAdapter.SECTION_LEVEL_1;
instance.section1();
instance.section1_();
instance.section( level, null );
instance.section_( level );
}
/**
* Test of section2 method, of class SinkAdapter.
*/
public void testSection2()
{
final int level = SinkAdapter.SECTION_LEVEL_2;
instance.section2();
instance.section2_();
instance.section( level, null );
instance.section_( level );
}
/**
* Test of section3 method, of class SinkAdapter.
*/
public void testSection3()
{
final int level = SinkAdapter.SECTION_LEVEL_3;
instance.section3();
instance.section3_();
instance.section( level, null );
instance.section_( level );
}
/**
* Test of section4 method, of class SinkAdapter.
*/
public void testSection4()
{
final int level = SinkAdapter.SECTION_LEVEL_4;
instance.section4();
instance.section4_();
instance.section( level, null );
instance.section_( level );
}
/**
* Test of section5 method, of class SinkAdapter.
*/
public void testSection5()
{
final int level = SinkAdapter.SECTION_LEVEL_5;
instance.section5();
instance.section5_();
instance.section( level, null );
instance.section_( level );
}
/**
* Test of list method, of class SinkAdapter.
*/
public void testList()
{
instance.list();
instance.list( null );
instance.list_();
}
/**
* Test of listItem method, of class SinkAdapter.
*/
public void testListItem()
{
instance.listItem();
instance.listItem( null );
instance.listItem_();
}
/**
* Test of numberedList method, of class SinkAdapter.
*/
public void testNumberedList()
{
final int numbering = SinkAdapter.NUMBERING_DECIMAL;
instance.numberedList( numbering );
instance.numberedList( numbering, null );
instance.numberedList_();
}
/**
* Test of numberedListItem method, of class SinkAdapter.
*/
public void testNumberedListItem()
{
instance.numberedListItem();
instance.numberedListItem( null );
instance.numberedListItem_();
}
/**
* Test of definitionList method, of class SinkAdapter.
*/
public void testDefinitionList()
{
instance.definitionList();
instance.definitionList( null );
instance.definitionList_();
}
/**
* Test of definitionListItem method, of class SinkAdapter.
*/
public void testDefinitionListItem()
{
instance.definitionListItem();
instance.definitionListItem( null );
instance.definitionListItem_();
}
/**
* Test of definition method, of class SinkAdapter.
*/
public void testDefinition()
{
instance.definition();
instance.definition( null );
instance.definition_();
}
/**
* Test of figure method, of class SinkAdapter.
*/
public void testFigure()
{
instance.figure();
instance.figure( null );
instance.figure_();
}
/**
* Test of table method, of class SinkAdapter.
*/
public void testTable()
{
instance.table();
instance.table( null );
instance.table_();
}
/**
* Test of tableRows method, of class SinkAdapter.
*/
public void testTableRows()
{
final int[] justification = null;
final boolean grid = false;
instance.tableRows( justification, grid );
instance.tableRows_();
}
/**
* Test of tableRow method, of class SinkAdapter.
*/
public void testTableRow()
{
instance.tableRow();
instance.tableRow( null );
instance.tableRow_();
}
/**
* Test of title method, of class SinkAdapter.
*/
public void testTitle()
{
instance.title();
instance.title( null );
instance.title_();
}
/**
* Test of author method, of class SinkAdapter.
*/
public void testAuthor()
{
instance.author();
instance.author( null );
instance.author_();
}
/**
* Test of date method, of class SinkAdapter.
*/
public void testDate()
{
instance.date();
instance.date( null );
instance.date_();
}
/**
* Test of sectionTitle method, of class SinkAdapter.
*/
public void testSectionTitle()
{
final int level = SinkAdapter.SECTION_LEVEL_1;
instance.sectionTitle();
instance.sectionTitle_();
instance.sectionTitle( level, null );
instance.sectionTitle_( level );
}
/**
* Test of sectionTitle1 method, of class SinkAdapter.
*/
public void testSectionTitle1()
{
final int level = SinkAdapter.SECTION_LEVEL_1;
instance.sectionTitle1();
instance.sectionTitle1_();
instance.sectionTitle( level, null );
instance.sectionTitle_( level );
}
/**
* Test of sectionTitle2 method, of class SinkAdapter.
*/
public void testSectionTitle2()
{
final int level = SinkAdapter.SECTION_LEVEL_2;
instance.sectionTitle2();
instance.sectionTitle2_();
instance.sectionTitle( level, null );
instance.sectionTitle_( level );
}
/**
* Test of sectionTitle3 method, of class SinkAdapter.
*/
public void testSectionTitle3()
{
final int level = SinkAdapter.SECTION_LEVEL_3;
instance.sectionTitle3();
instance.sectionTitle3_();
instance.sectionTitle( level, null );
instance.sectionTitle_( level );
}
/**
* Test of sectionTitle4 method, of class SinkAdapter.
*/
public void testSectionTitle4()
{
final int level = SinkAdapter.SECTION_LEVEL_4;
instance.sectionTitle4();
instance.sectionTitle4_();
instance.sectionTitle( level, null );
instance.sectionTitle_( level );
}
/**
* Test of sectionTitle5 method, of class SinkAdapter.
*/
public void testSectionTitle5()
{
final int level = SinkAdapter.SECTION_LEVEL_5;
instance.sectionTitle5();
instance.sectionTitle5_();
instance.sectionTitle( level, null );
instance.sectionTitle_( level );
}
/**
* Test of paragraph method, of class SinkAdapter.
*/
public void testParagraph()
{
instance.paragraph();
instance.paragraph( null );
instance.paragraph_();
}
/**
* Test of verbatim method, of class SinkAdapter.
*/
public void testVerbatim()
{
instance.verbatim( null );
instance.verbatim( false );
instance.verbatim_();
}
/**
* Test of definedTerm method, of class SinkAdapter.
*/
public void testDefinedTerm()
{
instance.definedTerm();
instance.definedTerm( null );
instance.definedTerm_();
}
/**
* Test of figureCaption method, of class SinkAdapter.
*/
public void testFigureCaption()
{
instance.figureCaption();
instance.figureCaption( null );
instance.figureCaption_();
}
/**
* Test of tableCell method, of class SinkAdapter.
*/
public void testTableCell()
{
instance.tableCell();
instance.tableCell( (SinkEventAttributes) null );
instance.tableCell( (String) null );
instance.tableCell_();
}
/**
* Test of tableHeaderCell method, of class SinkAdapter.
*/
public void testTableHeaderCell()
{
instance.tableHeaderCell();
instance.tableHeaderCell( (SinkEventAttributes) null );
instance.tableHeaderCell( (String) null );
instance.tableHeaderCell_();
}
/**
* Test of tableCaption method, of class SinkAdapter.
*/
public void testTableCaption()
{
instance.tableCaption();
instance.tableCaption( null );
instance.tableCaption_();
}
/**
* Test of figureGraphics method, of class SinkAdapter.
*/
public void testFigureGraphics()
{
String name = "";
instance.figureGraphics( name );
instance.figureGraphics( name, null );
}
/**
* Test of horizontalRule method, of class SinkAdapter.
*/
public void testHorizontalRule()
{
instance.horizontalRule();
instance.horizontalRule( null );
}
/**
* Test of pageBreak method, of class SinkAdapter.
*/
public void testPageBreak()
{
instance.pageBreak();
}
/**
* Test of anchor method, of class SinkAdapter.
*/
public void testAnchor()
{
String name = "";
instance.anchor( name );
instance.anchor( name, null );
instance.anchor_();
}
/**
* Test of link method, of class SinkAdapter.
*/
public void testLink()
{
String name = "";
instance.link( name );
instance.link( name, null );
instance.link_();
}
/**
* Test of italic method, of class SinkAdapter.
*/
public void testItalic()
{
instance.italic();
instance.italic_();
}
/**
* Test of bold method, of class SinkAdapter.
*/
public void testBold()
{
instance.bold();
instance.bold_();
}
/**
* Test of monospaced method, of class SinkAdapter.
*/
public void testMonospaced()
{
instance.monospaced();
instance.monospaced_();
}
/**
* Test of lineBreak method, of class SinkAdapter.
*/
public void testLineBreaks()
{
instance.lineBreak();
instance.lineBreak( null );
}
/**
* Test of nonBreakingSpace method, of class SinkAdapter.
*/
public void testNonBreakingSpace()
{
instance.nonBreakingSpace();
}
/**
* Test of text method, of class SinkAdapter.
*/
public void testText()
{
String text = "";
instance.text( text );
instance.text( text, null );
}
/**
* Test of rawText method, of class SinkAdapter.
*/
public void testRawText()
{
String text = "";
instance.rawText( text );
}
/**
* Test of comment method, of class SinkAdapter.
*/
public void testComment()
{
instance.comment( "" );
}
/**
* Test of flush method, of class SinkAdapter.
*/
public void testFlush()
{
instance.flush();
}
/**
* Test of close method, of class SinkAdapter.
*/
public void testClose()
{
instance.close();
}
/**
* Test of section method, of class SinkAdapter.
*/
public void testSection()
{
int level = 0;
instance.section( level, null );
instance.section_( level );
}
/**
* Test of unknown method, of class SinkAdapter.
*/
public void testUnknown()
{
String name = "";
Object[] requiredParams = null;
instance.unknown( name, requiredParams, null );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/WellformednessCheckingSink.java 0000644 0001750 0001750 00000040503 11244500235 032601 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.LinkedList;
import java.util.List;
import java.util.Stack;
/**
* This sink is used for testing purposes in order to check wether
* the input of some parser is well-formed.
*
* @author Lars Trieloff
* @version $Id: WellformednessCheckingSink.java 807164 2009-08-24 11:59:25Z vsiveton $
*/
public class WellformednessCheckingSink
extends AbstractSink
{
private final Stack elements = new Stack();
private final List errors = new LinkedList();
/** {@inheritDoc} */
public void head()
{
startElement( "head" );
}
/** {@inheritDoc} */
public void head_()
{
checkWellformedness( "head" );
}
/** {@inheritDoc} */
public void body()
{
startElement( "body" );
}
/** {@inheritDoc} */
public void body_()
{
checkWellformedness( "body" );
}
/** {@inheritDoc} */
public void section1()
{
startElement( "section1" );
}
/** {@inheritDoc} */
public void section1_()
{
checkWellformedness( "section1" );
}
/** {@inheritDoc} */
public void section2()
{
startElement( "section2" );
}
/** {@inheritDoc} */
public void section2_()
{
checkWellformedness( "section2" );
}
/** {@inheritDoc} */
public void section3()
{
startElement( "section3" );
}
/** {@inheritDoc} */
public void section3_()
{
checkWellformedness( "section3" );
}
/** {@inheritDoc} */
public void section4()
{
startElement( "section4" );
}
/** {@inheritDoc} */
public void section4_()
{
checkWellformedness( "section4" );
}
/** {@inheritDoc} */
public void section5()
{
startElement( "section5" );
}
/** {@inheritDoc} */
public void section5_()
{
checkWellformedness( "section5" );
}
/** {@inheritDoc} */
public void list()
{
startElement( "list" );
}
/** {@inheritDoc} */
public void list_()
{
checkWellformedness( "list" );
}
/** {@inheritDoc} */
public void listItem()
{
startElement( "listItem" );
}
/** {@inheritDoc} */
public void listItem_()
{
checkWellformedness( "listItem" );
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
startElement( "numberedList" );
}
/** {@inheritDoc} */
public void numberedList_()
{
checkWellformedness( "numberedList" );
}
/** {@inheritDoc} */
public void numberedListItem()
{
startElement( "numberedListItem" );
}
/** {@inheritDoc} */
public void numberedListItem_()
{
checkWellformedness( "numberedListItem" );
}
/** {@inheritDoc} */
public void definitionList()
{
startElement( "definitionList" );
}
/** {@inheritDoc} */
public void definitionList_()
{
checkWellformedness( "definitionList" );
}
/** {@inheritDoc} */
public void definitionListItem()
{
startElement( "definitionListItem" );
}
/** {@inheritDoc} */
public void definitionListItem_()
{
checkWellformedness( "definitionListItem" );
}
/** {@inheritDoc} */
public void definition()
{
startElement( "definition" );
}
/** {@inheritDoc} */
public void definition_()
{
checkWellformedness( "definition" );
}
/** {@inheritDoc} */
public void figure()
{
startElement( "figure" );
}
/** {@inheritDoc} */
public void figure_()
{
checkWellformedness( "figure" );
}
/** {@inheritDoc} */
public void table()
{
startElement( "table" );
}
/** {@inheritDoc} */
public void table_()
{
checkWellformedness( "table" );
}
/** {@inheritDoc} */
public void tableRows( int[] justification, boolean grid )
{
startElement( "tableRows" );
}
/** {@inheritDoc} */
public void tableRows_()
{
checkWellformedness( "tableRows" );
}
/** {@inheritDoc} */
public void tableRow()
{
startElement( "tableRow" );
}
/** {@inheritDoc} */
public void tableRow_()
{
checkWellformedness( "tableRow" );
}
/** {@inheritDoc} */
public void title()
{
startElement( "title" );
}
/** {@inheritDoc} */
public void title_()
{
checkWellformedness( "title" );
}
/** {@inheritDoc} */
public void author()
{
startElement( "author" );
}
/** {@inheritDoc} */
public void author_()
{
checkWellformedness( "author" );
}
/** {@inheritDoc} */
public void date()
{
startElement( "date" );
}
/** {@inheritDoc} */
public void date_()
{
checkWellformedness( "date" );
}
/** {@inheritDoc} */
public void sectionTitle()
{
startElement( "sectionTitle" );
}
/** {@inheritDoc} */
public void sectionTitle_()
{
checkWellformedness( "sectionTitle" );
}
/** {@inheritDoc} */
public void sectionTitle1()
{
startElement( "sectionTitle1" );
}
/** {@inheritDoc} */
public void sectionTitle1_()
{
checkWellformedness( "sectionTitle1" );
}
/** {@inheritDoc} */
public void sectionTitle2()
{
startElement( "sectionTitle2" );
}
/** {@inheritDoc} */
public void sectionTitle2_()
{
checkWellformedness( "sectionTitle2" );
}
/** {@inheritDoc} */
public void sectionTitle3()
{
startElement( "sectionTitle3" );
}
/** {@inheritDoc} */
public void sectionTitle3_()
{
checkWellformedness( "sectionTitle3" );
}
/** {@inheritDoc} */
public void sectionTitle4()
{
startElement( "sectionTitle4" );
}
/** {@inheritDoc} */
public void sectionTitle4_()
{
checkWellformedness( "sectionTitle4" );
}
/** {@inheritDoc} */
public void sectionTitle5()
{
startElement( "sectionTitle5" );
}
/** {@inheritDoc} */
public void sectionTitle5_()
{
checkWellformedness( "sectionTitle5" );
}
/** {@inheritDoc} */
public void paragraph()
{
startElement( "paragraph" );
}
/** {@inheritDoc} */
public void paragraph_()
{
checkWellformedness( "paragraph" );
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
startElement( "verbatim" );
}
/** {@inheritDoc} */
public void verbatim_()
{
checkWellformedness( "verbatim" );
}
/** {@inheritDoc} */
public void definedTerm()
{
startElement( "definedTerm" );
}
/** {@inheritDoc} */
public void definedTerm_()
{
checkWellformedness( "definedTerm" );
}
/** {@inheritDoc} */
public void figureCaption()
{
startElement( "figureCaption" );
}
/** {@inheritDoc} */
public void figureCaption_()
{
checkWellformedness( "figureCaption" );
}
/** {@inheritDoc} */
public void tableCell()
{
startElement( "tableCell" );
}
/** {@inheritDoc} */
public void tableCell( String width )
{
startElement( "tableCell" );
}
/** {@inheritDoc} */
public void tableCell_()
{
checkWellformedness( "tableCell" );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
startElement( "tableHeaderCell" );
}
/** {@inheritDoc} */
public void tableHeaderCell( String width )
{
startElement( "tableHeaderCell" );
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
checkWellformedness( "tableHeaderCell" );
}
/** {@inheritDoc} */
public void tableCaption()
{
startElement( "tableCaption" );
}
/** {@inheritDoc} */
public void tableCaption_()
{
checkWellformedness( "tableCaption" );
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
// nop
}
/** {@inheritDoc} */
public void horizontalRule()
{
// nop
}
/** {@inheritDoc} */
public void pageBreak()
{
// nop
}
/** {@inheritDoc} */
public void anchor( String name )
{
startElement( "anchor" );
}
/** {@inheritDoc} */
public void anchor_()
{
checkWellformedness( "anchor" );
}
/** {@inheritDoc} */
public void link( String name )
{
startElement( "link" );
}
/** {@inheritDoc} */
public void link_()
{
checkWellformedness( "link" );
}
/** {@inheritDoc} */
public void italic()
{
startElement( "italic" );
}
/** {@inheritDoc} */
public void italic_()
{
checkWellformedness( "italic" );
}
/** {@inheritDoc} */
public void bold()
{
startElement( "bold" );
}
/** {@inheritDoc} */
public void bold_()
{
checkWellformedness( "bold" );
}
/** {@inheritDoc} */
public void monospaced()
{
startElement( "monospaced" );
}
/** {@inheritDoc} */
public void monospaced_()
{
checkWellformedness( "monospaced" );
}
/** {@inheritDoc} */
public void lineBreak()
{
// nop
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
// nop
}
/** {@inheritDoc} */
public void text( String text )
{
// nop
}
/** {@inheritDoc} */
public void rawText( String text )
{
// nop
}
/** {@inheritDoc} */
public void comment( String comment )
{
// nop
}
/** {@inheritDoc} */
public void flush()
{
// nop
}
/** {@inheritDoc} */
public void close()
{
this.elements.clear();
this.errors.clear();
}
/**
* Finds out wether the wellformedness-contraints of the model have been
* violated.
*
* @return false for non-wellformed models
*/
public boolean isWellformed()
{
return errors.size() == 0;
}
/**
* Gets the offending element that breaks the wellformedness as well
* as the exepected element.
*
* @return the expected and acual elements
*/
public String getOffender()
{
if ( isWellformed() )
{
return null;
}
return (String) errors.get( errors.size() - 1 );
}
/**
* Gets the list of errors found during wellformedness-check
*
* @return a list of String of error messages
*/
public List getOffenders()
{
return errors;
}
/**
* Checks wether a newly encountered end-tag breaks the wellformedness
* of the model.
*
* @param actual the local-name of the encountered element
*/
private void checkWellformedness( String actual )
{
String expected = (String) elements.pop();
if ( !expected.equals( actual ) )
{
errors.add( "Encountered closing: " + actual + ", expected " + expected );
}
}
/**
* Starts a new element and puts it on the stack in order to calculate
* wellformedness of the model at a later point of time.
*
* @param string the local-name of the start-tag
*/
private void startElement( String string )
{
elements.push( string );
}
/** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
head();
}
/** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
title();
}
/** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
author();
}
/** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
date();
}
/** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
body();
}
/** {@inheritDoc} */
public void section( int level, SinkEventAttributes attributes )
{
startElement( "section" + level );
}
/** {@inheritDoc} */
public void section_( int level )
{
checkWellformedness( "section" + level );
}
/** {@inheritDoc} */
public void sectionTitle( int level, SinkEventAttributes attributes )
{
startElement( "sectionTitle" + level );
}
/** {@inheritDoc} */
public void sectionTitle_( int level )
{
checkWellformedness( "sectionTitle" + level );
}
/** {@inheritDoc} */
public void list( SinkEventAttributes attributes )
{
list();
}
/** {@inheritDoc} */
public void listItem( SinkEventAttributes attributes )
{
listItem();
}
/** {@inheritDoc} */
public void numberedList( int numbering, SinkEventAttributes attributes )
{
numberedList( numbering );
}
/** {@inheritDoc} */
public void numberedListItem( SinkEventAttributes attributes )
{
numberedListItem();
}
/** {@inheritDoc} */
public void definitionList( SinkEventAttributes attributes )
{
definitionList();
}
/** {@inheritDoc} */
public void definitionListItem( SinkEventAttributes attributes )
{
definitionListItem();
}
/** {@inheritDoc} */
public void definition( SinkEventAttributes attributes )
{
definition();
}
/** {@inheritDoc} */
public void definedTerm( SinkEventAttributes attributes )
{
definedTerm();
}
/** {@inheritDoc} */
public void figure( SinkEventAttributes attributes )
{
figure();
}
/** {@inheritDoc} */
public void figureCaption( SinkEventAttributes attributes )
{
figureCaption();
}
/** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
figureGraphics( src );
}
/** {@inheritDoc} */
public void table( SinkEventAttributes attributes )
{
table();
}
/** {@inheritDoc} */
public void tableRow( SinkEventAttributes attributes )
{
tableRow();
}
/** {@inheritDoc} */
public void tableCell( SinkEventAttributes attributes )
{
tableCell();
}
/** {@inheritDoc} */
public void tableHeaderCell( SinkEventAttributes attributes )
{
tableHeaderCell();
}
/** {@inheritDoc} */
public void tableCaption( SinkEventAttributes attributes )
{
tableCaption();
}
/** {@inheritDoc} */
public void paragraph( SinkEventAttributes attributes )
{
paragraph();
}
/** {@inheritDoc} */
public void verbatim( SinkEventAttributes attributes )
{
verbatim( false );
}
/** {@inheritDoc} */
public void horizontalRule( SinkEventAttributes attributes )
{
horizontalRule();
}
/** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
anchor( name );
}
/** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
link( name );
}
/** {@inheritDoc} */
public void lineBreak( SinkEventAttributes attributes )
{
lineBreak();
}
/** {@inheritDoc} */
public void text( String text, SinkEventAttributes attributes )
{
text( text );
}
/** {@inheritDoc} */
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
// ignore
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/XhtmlBaseSinkTest.java 0000644 0001750 0001750 00000054751 11351662460 030725 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringWriter;
import java.io.Writer;
import org.codehaus.plexus.PlexusTestCase;
/**
* Test for XhtmlBaseSink.
*
* @author ltheussl
* @version $Id: XhtmlBaseSinkTest.java 926049 2010-03-22 12:40:16Z ltheussl $
* @since 1.1
*/
public class XhtmlBaseSinkTest
extends PlexusTestCase
{
private final SinkEventAttributes attributes =
new SinkEventAttributeSet( new String[] {SinkEventAttributes.STYLE, "bold"} );
private XhtmlBaseSink sink;
private Writer writer;
/**
* Set up the writer.
*
* @throws java.lang.Exception if any.
*/
protected void setUp()
throws Exception
{
super.setUp();
writer = new StringWriter();
}
/** @throws Exception */
public void testSpaceAfterClosingTag()
throws Exception
{
// DOXIA-189
try
{
sink = new XhtmlBaseSink( writer );
sink.paragraph();
sink.text( "There should be no space before the " );
sink.italic();
sink.text( "period" );
sink.italic_();
sink.text( "." );
sink.paragraph_();
}
finally
{
if ( sink != null )
{
sink.close();
}
}
String actual = writer.toString();
String expected = "
", writer.toString() );
}
/**
* Test of horizontalRule method, of class XhtmlBaseSink.
*/
public void testHorizontalRule()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.horizontalRule();
sink.horizontalRule( attributes );
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test of table method, of class XhtmlBaseSink.
*/
public void testTable()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.table( attributes );
sink.table_();
}
finally
{
sink.close();
}
assertEquals( "
", writer.toString() );
}
/**
* Test of tableRows method, of class XhtmlBaseSink.
*/
public void testTableRows()
{
final int[] justification = null;
final boolean grid = false;
try
{
sink = new XhtmlBaseSink( writer );
sink.tableRows( justification, grid );
sink.tableRows_();
}
finally
{
sink.close();
}
assertEquals( "
", writer.toString() );
}
/**
* Test of tableRow method, of class XhtmlBaseSink.
*/
public void testTableRow()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.tableRow( attributes );
sink.tableRow_();
}
finally
{
sink.close();
}
assertEquals( "
", writer.toString() );
}
/**
* Test of tableCell method, of class XhtmlBaseSink.
*/
public void testTableCell()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.tableCell( attributes );
sink.tableCell_();
}
finally
{
sink.close();
}
assertEquals( "
", writer.toString() );
}
/**
* Test of tableHeaderCell method, of class XhtmlBaseSink.
*/
public void testTableHeaderCell()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.tableHeaderCell( attributes );
sink.tableHeaderCell_();
}
finally
{
sink.close();
}
assertEquals( "
", writer.toString() );
}
/**
* Test of tableCaption method, of class XhtmlBaseSink.
*/
public void testTableCaption()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.table();
sink.tableRows( null, false );
sink.tableCaption( attributes );
sink.text( "caption" );
sink.tableCaption_();
sink.tableRows_();
sink.table_();
}
finally
{
sink.close();
}
assertEquals( "
" +
"
caption
", writer.toString() );
}
/**
* Test of anchor method, of class XhtmlBaseSink.
*/
public void testAnchor()
{
String name = "anchor";
try
{
sink = new XhtmlBaseSink( writer );
sink.anchor( name, attributes );
sink.anchor_();
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test of link method, of class XhtmlBaseSink.
*/
public void testLink()
{
final String name = "link.html";
try
{
sink = new XhtmlBaseSink( writer );
sink.link( name, attributes );
sink.link_();
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test of italic/bold/monospaced method, of class XhtmlBaseSink.
*/
public void testItalic()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.italic();
sink.italic_();
sink.bold();
sink.bold_();
sink.monospaced();
sink.monospaced_();
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test of lineBreak/pageBreak/nonBreakingSpace method, of class XhtmlBaseSink.
*/
public void testLineBreak()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.lineBreak( attributes );
sink.pageBreak();
sink.nonBreakingSpace();
}
finally
{
sink.close();
}
assertEquals( " ", writer.toString() );
}
/**
* Test of text method, of class XhtmlBaseSink.
*/
public void testText()
{
String text = "a text & \u00c6";
try
{
sink = new XhtmlBaseSink( writer );
sink.text( text );
}
finally
{
sink.close();
}
assertEquals( "a text & Æ", writer.toString() );
writer = new StringWriter();
try
{
sink = new XhtmlBaseSink( writer );
sink.text( text, attributes );
}
finally
{
sink.close();
}
assertEquals( "a text & Æ", writer.toString() );
}
/**
* Test of rawText method, of class XhtmlBaseSink.
*/
public void testRawText()
{
String text = "raw text";
try
{
sink = new XhtmlBaseSink( writer );
sink.rawText( text );
}
finally
{
sink.close();
}
assertEquals( "raw text", writer.toString() );
}
/**
* Test of comment method, of class XhtmlBaseSink.
*/
public void testComment()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.comment( "a comment" );
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test of unknown method, of class XhtmlBaseSink.
*/
public void testUnknown()
{
final String name = "unknown";
final Object[] requiredParams = null;
try
{
sink = new XhtmlBaseSink( writer );
sink.unknown( name, requiredParams, attributes );
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test entities in attribute values.
*/
public void testAttributeEntities()
{
final Object[] startTag = new Object[] { new Integer( XhtmlBaseSink.TAG_TYPE_START ) };
final Object[] endTag = new Object[] { new Integer( XhtmlBaseSink.TAG_TYPE_END ) };
final String script = XhtmlBaseSink.SCRIPT.toString();
final SinkEventAttributes src = new SinkEventAttributeSet(
new String[] {SinkEventAttributes.SRC.toString(), "http://ex.com/ex.js?v=l&l=e"} );
try
{
sink = new XhtmlBaseSink( writer );
sink.unknown( script, startTag, src );
sink.unknown( script, endTag, null );
sink.figureGraphics( "http://ex.com/ex.jpg?v=l&l=e", src );
}
finally
{
sink.close();
}
String result = writer.toString();
assertTrue( result.indexOf( "ex.js?v=l&l=e" ) != -1 );
assertTrue( result.indexOf( "ex.jpg?v=l&l=e" ) != -1 );
}
/**
* Test of entity.
*/
public void testEntity()
{
// DOXIA-314
String text = "a text '𝟭'";
try
{
sink = new XhtmlBaseSink( writer );
sink.text( text );
}
finally
{
sink.close();
}
assertEquals( "a text '𝟭'", writer.toString() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/SinkEventTestingSink.java 0000644 0001750 0001750 00000041246 11163505460 031432 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.LinkedList;
import java.util.List;
/**
* This sink is used for testing purposes in order to check wether
* the input of some parser is well-formed.
*
* @author ltheussl
* @version $Id: SinkEventTestingSink.java 759581 2009-03-28 20:40:16Z ltheussl $
* @since 1.1
*/
public class SinkEventTestingSink
extends AbstractSink
{
/** The list of sink events. */
private final List events = new LinkedList();
/**
* Return the collected list of SinkEventElements.
*
* @return the collected list of SinkEventElements.
*/
public List getEventList()
{
return this.events;
}
/** Clears the list of sink events. */
public void reset()
{
this.events.clear();
}
//
// sink methods
//
/** {@inheritDoc} */
public void head()
{
addEvent( "head" );
}
/** {@inheritDoc} */
public void head_()
{
addEvent( "head_" );
}
/** {@inheritDoc} */
public void body()
{
addEvent( "body" );
}
/** {@inheritDoc} */
public void body_()
{
addEvent( "body_" );
}
/** {@inheritDoc} */
public void section1()
{
addEvent( "section1" );
}
/** {@inheritDoc} */
public void section1_()
{
addEvent( "section1_" );
}
/** {@inheritDoc} */
public void section2()
{
addEvent( "section2" );
}
/** {@inheritDoc} */
public void section2_()
{
addEvent( "section2_" );
}
/** {@inheritDoc} */
public void section3()
{
addEvent( "section3" );
}
/** {@inheritDoc} */
public void section3_()
{
addEvent( "section3_" );
}
/** {@inheritDoc} */
public void section4()
{
addEvent( "section4" );
}
/** {@inheritDoc} */
public void section4_()
{
addEvent( "section4_" );
}
/** {@inheritDoc} */
public void section5()
{
addEvent( "section5" );
}
/** {@inheritDoc} */
public void section5_()
{
addEvent( "section5_" );
}
/** {@inheritDoc} */
public void list()
{
addEvent( "list" );
}
/** {@inheritDoc} */
public void list_()
{
addEvent( "list_" );
}
/** {@inheritDoc} */
public void listItem()
{
addEvent( "listItem" );
}
/** {@inheritDoc} */
public void listItem_()
{
addEvent( "listItem_" );
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
addEvent( "numberedList", new Object[] {new Integer( numbering )} );
}
/** {@inheritDoc} */
public void numberedList_()
{
addEvent( "numberedList_" );
}
/** {@inheritDoc} */
public void numberedListItem()
{
addEvent( "numberedListItem" );
}
/** {@inheritDoc} */
public void numberedListItem_()
{
addEvent( "numberedListItem_" );
}
/** {@inheritDoc} */
public void definitionList()
{
addEvent( "definitionList" );
}
/** {@inheritDoc} */
public void definitionList_()
{
addEvent( "definitionList_" );
}
/** {@inheritDoc} */
public void definitionListItem()
{
addEvent( "definitionListItem" );
}
/** {@inheritDoc} */
public void definitionListItem_()
{
addEvent( "definitionListItem_" );
}
/** {@inheritDoc} */
public void definition()
{
addEvent( "definition" );
}
/** {@inheritDoc} */
public void definition_()
{
addEvent( "definition_" );
}
/** {@inheritDoc} */
public void figure()
{
addEvent( "figure" );
}
/** {@inheritDoc} */
public void figure_()
{
addEvent( "figure_" );
}
/** {@inheritDoc} */
public void table()
{
addEvent( "table" );
}
/** {@inheritDoc} */
public void table_()
{
addEvent( "table_" );
}
/** {@inheritDoc} */
public void tableRows( int[] justification, boolean grid )
{
addEvent( "tableRows", new Object[] {justification, new Boolean( grid )} );
}
/** {@inheritDoc} */
public void tableRows_()
{
addEvent( "tableRows_" );
}
/** {@inheritDoc} */
public void tableRow()
{
addEvent( "tableRow" );
}
/** {@inheritDoc} */
public void tableRow_()
{
addEvent( "tableRow_" );
}
/** {@inheritDoc} */
public void title()
{
addEvent( "title" );
}
/** {@inheritDoc} */
public void title_()
{
addEvent( "title_" );
}
/** {@inheritDoc} */
public void author()
{
addEvent( "author" );
}
/** {@inheritDoc} */
public void author_()
{
addEvent( "author_" );
}
/** {@inheritDoc} */
public void date()
{
addEvent( "date" );
}
/** {@inheritDoc} */
public void date_()
{
addEvent( "date_" );
}
/** {@inheritDoc} */
public void sectionTitle()
{
addEvent( "sectionTitle" );
}
/** {@inheritDoc} */
public void sectionTitle_()
{
addEvent( "sectionTitle_" );
}
/** {@inheritDoc} */
public void sectionTitle1()
{
addEvent( "sectionTitle1" );
}
/** {@inheritDoc} */
public void sectionTitle1_()
{
addEvent( "sectionTitle1_" );
}
/** {@inheritDoc} */
public void sectionTitle2()
{
addEvent( "sectionTitle2" );
}
/** {@inheritDoc} */
public void sectionTitle2_()
{
addEvent( "sectionTitle2_" );
}
/** {@inheritDoc} */
public void sectionTitle3()
{
addEvent( "sectionTitle3" );
}
/** {@inheritDoc} */
public void sectionTitle3_()
{
addEvent( "sectionTitle3_" );
}
/** {@inheritDoc} */
public void sectionTitle4()
{
addEvent( "sectionTitle4" );
}
/** {@inheritDoc} */
public void sectionTitle4_()
{
addEvent( "sectionTitle4_" );
}
/** {@inheritDoc} */
public void sectionTitle5()
{
addEvent( "sectionTitle5" );
}
/** {@inheritDoc} */
public void sectionTitle5_()
{
addEvent( "sectionTitle5_" );
}
/** {@inheritDoc} */
public void paragraph()
{
addEvent( "paragraph" );
}
/** {@inheritDoc} */
public void paragraph_()
{
addEvent( "paragraph_" );
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
addEvent( "verbatim", new Object[] {new Boolean( boxed )} );
}
/** {@inheritDoc} */
public void verbatim_()
{
addEvent( "verbatim_" );
}
/** {@inheritDoc} */
public void definedTerm()
{
addEvent( "definedTerm" );
}
/** {@inheritDoc} */
public void definedTerm_()
{
addEvent( "definedTerm_" );
}
/** {@inheritDoc} */
public void figureCaption()
{
addEvent( "figureCaption" );
}
/** {@inheritDoc} */
public void figureCaption_()
{
addEvent( "figureCaption_" );
}
/** {@inheritDoc} */
public void tableCell()
{
addEvent( "tableCell" );
}
/** {@inheritDoc} */
public void tableCell( String width )
{
addEvent( "tableCell", new Object[] {width} );
}
/** {@inheritDoc} */
public void tableCell_()
{
addEvent( "tableCell_" );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
addEvent( "tableHeaderCell" );
}
/** {@inheritDoc} */
public void tableHeaderCell( String width )
{
addEvent( "tableHeaderCell", new Object[] {width} );
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
addEvent( "tableHeaderCell_" );
}
/** {@inheritDoc} */
public void tableCaption()
{
addEvent( "tableCaption" );
}
/** {@inheritDoc} */
public void tableCaption_()
{
addEvent( "tableCaption_" );
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
addEvent( "figureGraphics", new Object[] {name} );
}
/** {@inheritDoc} */
public void horizontalRule()
{
addEvent( "horizontalRule" );
}
/** {@inheritDoc} */
public void pageBreak()
{
addEvent( "pageBreak" );
}
/** {@inheritDoc} */
public void anchor( String name )
{
addEvent( "anchor", new Object[] {name} );
}
/** {@inheritDoc} */
public void anchor_()
{
addEvent( "anchor_" );
}
/** {@inheritDoc} */
public void link( String name )
{
addEvent( "link", new Object[] {name} );
}
/** {@inheritDoc} */
public void link_()
{
addEvent( "link_" );
}
/** {@inheritDoc} */
public void italic()
{
addEvent( "italic" );
}
/** {@inheritDoc} */
public void italic_()
{
addEvent( "italic_" );
}
/** {@inheritDoc} */
public void bold()
{
addEvent( "bold" );
}
/** {@inheritDoc} */
public void bold_()
{
addEvent( "bold_" );
}
/** {@inheritDoc} */
public void monospaced()
{
addEvent( "monospaced" );
}
/** {@inheritDoc} */
public void monospaced_()
{
addEvent( "monospaced_" );
}
/** {@inheritDoc} */
public void lineBreak()
{
addEvent( "lineBreak" );
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
addEvent( "nonBreakingSpace" );
}
/** {@inheritDoc} */
public void text( String text )
{
addEvent( "text", new Object[] {text} );
}
/** {@inheritDoc} */
public void rawText( String text )
{
addEvent( "rawText", new Object[] {text} );
}
/** {@inheritDoc} */
public void comment( String comment )
{
addEvent( "comment", new Object[] {comment} );
}
/** {@inheritDoc} */
public void flush()
{
addEvent( "flush" );
}
/** {@inheritDoc} */
public void close()
{
addEvent( "close" );
}
/** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
addEvent( "head", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
addEvent( "title", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
addEvent( "author", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
addEvent( "date", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
addEvent( "body", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void section( int level, SinkEventAttributes attributes )
{
addEvent( "section" + level, new Object[] {attributes} );
}
/** {@inheritDoc} */
public void section_( int level )
{
addEvent( "section" + level + "_" );
}
/** {@inheritDoc} */
public void sectionTitle( int level, SinkEventAttributes attributes )
{
addEvent( "sectionTitle" + level, new Object[] {attributes} );
}
/** {@inheritDoc} */
public void sectionTitle_( int level )
{
addEvent( "sectionTitle" + level + "_" );
}
/** {@inheritDoc} */
public void list( SinkEventAttributes attributes )
{
addEvent( "list", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void listItem( SinkEventAttributes attributes )
{
addEvent( "listItem", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void numberedList( int numbering, SinkEventAttributes attributes )
{
addEvent( "numberedList", new Object[] {new Integer( numbering ), attributes} );
}
/** {@inheritDoc} */
public void numberedListItem( SinkEventAttributes attributes )
{
addEvent( "numberedListItem", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void definitionList( SinkEventAttributes attributes )
{
addEvent( "definitionList", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void definitionListItem( SinkEventAttributes attributes )
{
addEvent( "definitionListItem", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void definition( SinkEventAttributes attributes )
{
addEvent( "definition", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void definedTerm( SinkEventAttributes attributes )
{
addEvent( "definedTerm", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void figure( SinkEventAttributes attributes )
{
addEvent( "figure", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void figureCaption( SinkEventAttributes attributes )
{
addEvent( "figureCaption", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
addEvent( "figureGraphics", new Object[] {src, attributes} );
}
/** {@inheritDoc} */
public void table( SinkEventAttributes attributes )
{
addEvent( "table", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void tableRow( SinkEventAttributes attributes )
{
addEvent( "tableRow", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void tableCell( SinkEventAttributes attributes )
{
addEvent( "tableCell", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void tableHeaderCell( SinkEventAttributes attributes )
{
addEvent( "tableHeaderCell", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void tableCaption( SinkEventAttributes attributes )
{
addEvent( "tableCaption", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void paragraph( SinkEventAttributes attributes )
{
addEvent( "paragraph", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void verbatim( SinkEventAttributes attributes )
{
addEvent( "verbatim", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void horizontalRule( SinkEventAttributes attributes )
{
addEvent( "horizontalRule", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
addEvent( "anchor", new Object[] {name, attributes} );
}
/** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
addEvent( "link", new Object[] {name, attributes} );
}
/** {@inheritDoc} */
public void lineBreak( SinkEventAttributes attributes )
{
addEvent( "lineBreak", new Object[] {attributes} );
}
/** {@inheritDoc} */
public void text( String text, SinkEventAttributes attributes )
{
addEvent( "text", new Object[] {text, attributes} );
}
/** {@inheritDoc} */
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
addEvent( "unknown", new Object[] {name, requiredParams, attributes} );
}
//
// private
//
/**
* Adds a no-arg event to the list of events.
*
* @param string the name of the event.
*/
private void addEvent( String string )
{
addEvent( string, null );
}
/**
* Adds an event to the list of events.
*
* @param string the name of the event.
* @param arguments The array of arguments to the sink method.
*/
private void addEvent( String string, Object[] arguments )
{
events.add( new SinkEventElement( string, arguments ) );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/SinkEventElement.java 0000644 0001750 0001750 00000004710 11202253554 030552 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.commons.lang.builder.ToStringBuilder;
/**
* A single sink event, used for testing purposes in order to check
* the order and effect of some parser events.
*
* @author ltheussl
* @version $Id: SinkEventElement.java 773849 2009-05-12 11:03:08Z vsiveton $
* @since 1.1
*/
public class SinkEventElement
{
/** The name of the sink event, ie the sink method name. */
private final String methodName;
/** The array of arguments to the sink method. */
private final Object[] args;
/**
* A SinkEventElement is characterized by the method name and associated array of arguments.
*
* @param name The name of the sink event, ie the sink method name.
* @param arguments The array of arguments to the sink method.
* For a no-arg element this may be null or an empty array.
*/
public SinkEventElement( String name, Object[] arguments )
{
if ( name == null )
{
throw new NullPointerException( "Element name can't be null!" );
}
this.methodName = name;
this.args = arguments;
}
/**
* Return the name of the this event.
*
* @return The name of the sink event.
*/
public String getName()
{
return this.methodName;
}
/**
* Return the array of arguments to the sink method.
*
* @return the array of arguments to the sink method.
*/
public Object[] getArgs()
{
return this.args;
}
/**
* {@inheritDoc}
* @since 1.1.1
*/
public String toString()
{
return ToStringBuilder.reflectionToString( this );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/SinkTestDocument.java 0000644 0001750 0001750 00000035436 11207725677 030625 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Static methods to generate standard Doxia sink events.
*
* @version $Id: SinkTestDocument.java 779902 2009-05-29 09:32:47Z ltheussl $
*/
public class SinkTestDocument
{
/** Private constructor. */
private SinkTestDocument()
{
// do not instantiate
}
/**
* Dumps a full model that mimics aptconvert's test.apt,
* into the specified sink. The sink is flushed but not closed.
*
* @param sink The sink to receive the events.
*/
public static void generate( Sink sink )
{
generateHead( sink );
sink.body();
// TODO: what is this supposed to do?
//sink.sectionTitle();
//sink.text( "Section Title" );
//sink.sectionTitle_();
sink.paragraph();
sink.text( "Paragraph 1, line 1. Paragraph 1, line 2." );
sink.paragraph_();
sink.paragraph();
sink.text( "Paragraph 2, line 1. Paragraph 2, line 2." );
sink.paragraph_();
sink.section1();
sink.sectionTitle1();
sink.text( "Section title" );
sink.sectionTitle1_();
sink.section2();
sink.sectionTitle2();
sink.text( "Sub-section title" );
sink.sectionTitle2_();
sink.section3();
sink.sectionTitle3();
sink.text( "Sub-sub-section title" );
sink.sectionTitle3_();
sink.section4();
sink.sectionTitle4();
sink.text( "Sub-sub-sub-section title" );
sink.sectionTitle4_();
sink.section5();
sink.sectionTitle5();
sink.text( "Sub-sub-sub-sub-section title" );
sink.sectionTitle5_();
generateList( sink );
sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( "Verbatim text not contained in list item 3" );
sink.verbatim_();
generateNumberedList( sink );
sink.paragraph();
sink.text( "List numbering schemes: [[1]], [[a]], [[A]], [[i]], [[I]]." );
sink.paragraph_();
generateDefinitionList( sink );
sink.paragraph();
sink.text( "--- instead of +-- suppresses the box around verbatim text." );
sink.paragraph_();
generateFigure( sink );
generateTable( sink );
sink.paragraph();
sink.text( "No grid, no caption:" );
sink.paragraph_();
generateNoGridTable( sink );
generateHeaderTable( sink );
generateHorizontalRule( sink );
generatePageBreak( sink );
generateFonts( sink );
generateAnchors( sink );
generateLineBreak( sink );
generateNonBreakingSpace( sink );
generateSpecialCharacters( sink );
sink.comment( "A comment!" );
sink.section5_();
sink.section4_();
sink.section3_();
sink.section2_();
sink.section1_();
sink.body_();
sink.flush();
}
/**
* Dumps a header with title, author and date elements
* into the specified sink. The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateHead( Sink sink )
{
sink.head();
sink.title();
sink.text( "Title" );
sink.title_();
sink.author();
sink.text( "Author" );
sink.author_();
sink.date();
sink.text( "Date" );
sink.date_();
sink.head_();
}
/**
* Dumps a list into the specified sink. The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateList( Sink sink )
{
sink.list();
sink.listItem();
sink.text( "List item 1." );
sink.listItem_();
sink.listItem();
sink.text( "List item 2." );
sink.paragraph();
sink.text( "Paragraph contained in list item 2." );
sink.paragraph_();
sink.list();
sink.listItem();
sink.text( "Sub-list item 1." );
sink.listItem_();
sink.listItem();
sink.text( "Sub-list item 2." );
sink.listItem_();
sink.list_();
sink.listItem_();
sink.listItem();
sink.text( "List item 3. Force end of list:" );
sink.listItem_();
sink.list_();
}
/**
* Dumps a numbered list into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateNumberedList( Sink sink )
{
sink.numberedList( Sink.NUMBERING_DECIMAL );
sink.numberedListItem();
sink.text( "Numbered item 1." );
sink.numberedList( Sink.NUMBERING_UPPER_ALPHA );
sink.numberedListItem();
sink.text( "Numbered item A." );
sink.numberedListItem_();
sink.numberedListItem();
sink.text( "Numbered item B." );
sink.numberedListItem_();
sink.numberedList_();
sink.numberedListItem_();
sink.numberedListItem();
sink.text( "Numbered item 2." );
sink.numberedListItem_();
sink.numberedList_();
}
/**
* Dumps a definition list into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateDefinitionList( Sink sink )
{
String eol = System.getProperty( "line.separator" );
sink.definitionList();
sink.definitionListItem();
sink.definedTerm();
sink.text( "Defined term 1" );
sink.definedTerm_();
sink.definition();
sink.text( "of definition list." );
sink.definition_();
sink.definitionListItem_();
sink.definitionListItem();
sink.definedTerm();
sink.text( "Defined term 2" );
sink.definedTerm_();
sink.definition();
sink.text( "of definition list." );
sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( "Verbatim text" + eol + " in a box " );
sink.verbatim_();
sink.definition_();
sink.definitionListItem_();
sink.definitionList_();
}
/**
* Dumps a figure with figure caption into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateFigure( Sink sink )
{
sink.figure( null );
sink.figureGraphics( "figure.png", null );
sink.figureCaption( null );
sink.text( "Figure caption", null );
sink.figureCaption_();
sink.figure_();
}
/**
* Dumps a table with grid and caption into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateTable( Sink sink )
{
int[] justify =
{
Sink.JUSTIFY_CENTER, Sink.JUSTIFY_LEFT, Sink.JUSTIFY_RIGHT
};
sink.table();
sink.tableRows( justify, true );
sink.tableRow();
sink.tableCell();
sink.text( "Centered" );
sink.lineBreak();
sink.text( "cell 1,1" );
sink.tableCell_();
sink.tableCell();
sink.text( "Left-aligned" );
sink.lineBreak();
sink.text( "cell 1,2" );
sink.tableCell_();
sink.tableCell();
sink.text( "Right-aligned" );
sink.lineBreak();
sink.text( "cell 1,3" );
sink.tableCell_();
sink.tableRow_();
sink.tableRow();
sink.tableCell();
sink.text( "cell 2,1" );
sink.tableCell_();
sink.tableCell();
sink.text( "cell 2,2" );
sink.tableCell_();
sink.tableCell();
sink.text( "cell 2,3" );
sink.tableCell_();
sink.tableRow_();
sink.tableRows_();
sink.tableCaption();
sink.text( "Table caption" );
sink.tableCaption_();
sink.table_();
}
/**
* Dumps a table without grid into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateNoGridTable( Sink sink )
{
int[] justify =
{
Sink.JUSTIFY_CENTER, Sink.JUSTIFY_CENTER
};
sink.table();
sink.tableRows( justify, false );
sink.tableRow();
sink.tableCell();
sink.text( "cell" );
sink.tableCell_();
sink.tableCell();
sink.text( "cell" );
sink.tableCell_();
sink.tableRow_();
sink.tableRow();
sink.tableCell();
sink.text( "cell" );
sink.tableCell_();
sink.tableCell();
sink.text( "cell" );
sink.tableCell_();
sink.tableRow_();
sink.tableRows_();
sink.table_();
}
/**
* Dumps a table with a header row into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateHeaderTable( Sink sink )
{
int[] justify =
{
Sink.JUSTIFY_CENTER, Sink.JUSTIFY_CENTER
};
sink.table();
sink.tableRows( justify, true );
sink.tableRow();
sink.tableHeaderCell();
sink.text( "header" );
sink.tableHeaderCell_();
sink.tableHeaderCell();
sink.text( "header" );
sink.tableHeaderCell_();
sink.tableRow_();
sink.tableRow();
sink.tableCell();
sink.text( "cell" );
sink.tableCell_();
sink.tableCell();
sink.text( "cell" );
sink.tableCell_();
sink.tableRow_();
sink.tableRows_();
sink.table_();
}
/**
* Dumps a paragraph with italic, bold and monospaced text
* into the specified sink. The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateFonts( Sink sink )
{
sink.paragraph();
sink.italic();
sink.text( "Italic" );
sink.italic_();
sink.text( " font. " );
sink.bold();
sink.text( "Bold" );
sink.bold_();
sink.text( " font. " );
sink.monospaced();
sink.text( "Monospaced" );
sink.monospaced_();
sink.text( " font." );
sink.paragraph_();
}
/**
* Dumps a paragraph with anchor and link elements
* into the specified sink. The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateAnchors( Sink sink )
{
sink.paragraph();
sink.anchor( "Anchor" );
sink.text( "Anchor" );
sink.anchor_();
sink.text( ". Link to " );
sink.link( "#Anchor" );
sink.text( "Anchor" );
sink.link_();
sink.text( ". Link to " );
sink.link( "http://www.pixware.fr" );
sink.text( "http://www.pixware.fr" );
sink.link_();
sink.text( ". Link to " );
sink.link( "#Anchor" );
sink.text( "showing alternate text" );
sink.link_();
sink.text( ". Link to " );
sink.link( "http://www.pixware.fr" );
sink.text( "Pixware home page" );
sink.link_();
sink.text( "." );
sink.paragraph_();
}
/**
* Dumps a horizontal rule block into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateHorizontalRule( Sink sink )
{
sink.paragraph();
sink.text( "Horizontal line:" );
sink.paragraph_();
sink.horizontalRule();
}
/**
* Dumps a pageBreak block into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generatePageBreak( Sink sink )
{
sink.pageBreak();
sink.paragraph();
sink.text( "New page." );
sink.paragraph_();
}
/**
* Dumps a lineBreak block into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateLineBreak( Sink sink )
{
sink.paragraph();
sink.text( "Force line" );
sink.lineBreak();
sink.text( "break." );
sink.paragraph_();
}
/**
* Dumps a nonBreakingSpace block into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateNonBreakingSpace( Sink sink )
{
sink.paragraph();
sink.text( "Non" );
sink.nonBreakingSpace();
sink.text( "breaking" );
sink.nonBreakingSpace();
sink.text( "space." );
sink.paragraph_();
}
/**
* Dumps a special character block into the specified sink.
* The sink is not flushed or closed.
*
* @param sink The sink to receive the events.
*/
public static void generateSpecialCharacters( Sink sink )
{
sink.paragraph();
sink.text( "Escaped special characters:" );
sink.lineBreak();
sink.text( "~" );
sink.lineBreak();
sink.text( "=" );
sink.lineBreak();
sink.text( "-" );
sink.lineBreak();
sink.text( "+" );
sink.lineBreak();
sink.text( "*" );
sink.lineBreak();
sink.text( "[" );
sink.lineBreak();
sink.text( "]" );
sink.lineBreak();
sink.text( "<" );
sink.lineBreak();
sink.text( ">" );
sink.lineBreak();
sink.text( "{" );
sink.lineBreak();
sink.text( "}" );
sink.lineBreak();
sink.text( "\\" );
sink.paragraph_();
sink.paragraph();
sink.text( "Copyright symbol:" );
sink.lineBreak();
sink.text( "\u00a9" );
sink.paragraph_();
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTest.java 0000644 0001750 0001750 00000075605 11207760454 030604 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.AbstractModuleTest;
import org.apache.maven.doxia.logging.PlexusLoggerWrapper;
import org.codehaus.plexus.util.IOUtil;
import java.io.CharArrayWriter;
import java.io.IOException;
import java.io.Writer;
/**
* Abstract base class to test sinks.
*
* @version $Id: AbstractSinkTest.java 779959 2009-05-29 13:20:44Z vsiveton $
* @since 1.0
*/
public abstract class AbstractSinkTest
extends AbstractModuleTest
{
private final CharArrayWriter testWriter = new CharArrayWriter();
private Sink sink;
/**
* Resets the writer and creates a new sink with it.
*
* {@inheritDoc}
*
* @throws java.lang.Exception if something goes wrong.
*/
protected void setUp()
throws Exception
{
super.setUp();
testWriter.reset();
sink = createSink( testWriter );
sink.enableLogging( new PlexusLoggerWrapper( getContainer().getLogger() ) );
}
// ---------------------------------------------------------------------
// Common test cases
// ----------------------------------------------------------------------
/**
* Tests that the current sink is able to render the common test document. If the sink is an Xml sink defined
* by {@link #isXmlSink()}, it uses an Xml Writer defined by {@link #getXmlTestWriter(String)}. If not, it uses
* the Writer defined by {@link #getTestWriter(String)}.
*
* @see SinkTestDocument
* @throws IOException If the target test document could not be generated.
* @see #isXmlSink()
* @see #getTestWriter(String)
* @see #getXmlTestWriter(String)
*/
public final void testTestDocument() throws IOException
{
Writer writer = ( isXmlSink() ? getXmlTestWriter( "testDocument" ) : getTestWriter( "testDocument" ) );
Sink testSink = createSink( writer );
try
{
SinkTestDocument.generate( testSink );
}
finally
{
testSink.close();
IOUtil.close( writer );
}
}
/**
* Checks that the sequence [title(), text( title ), title_()],
* invoked on the current sink, produces the same result as
* {@link #getTitleBlock getTitleBlock}( title ).
*/
public void testTitle()
{
String title = "Grodek";
sink.title();
sink.text( title );
sink.title_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getTitleBlock( title );
assertEquals( "Wrong title!", expected, actual );
}
/**
* Checks that the sequence [author(), text( author ), author_()]
* , invoked on the current sink, produces the same result as
* {@link #getAuthorBlock getAuthorBlock}( author ).
*/
public void testAuthor()
{
String author = "Georg_Trakl";
sink.author();
sink.text( author );
sink.author_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getAuthorBlock( author );
assertEquals( "Wrong author!", expected, actual );
}
/**
* Checks that the sequence [date(), text( date ), date_()],
* invoked on the current sink, produces the same result as
* {@link #getDateBlock getDateBlock}( date ).
*/
public void testDate()
{
String date = "1914";
sink.date();
sink.text( date );
sink.date_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getDateBlock( date );
assertEquals( "Wrong date!", expected, actual );
}
/**
* Checks that the sequence [head(), head_()],
* invoked on the current sink, produces the same result as
* {@link #getHeadBlock getHeadBlock()}.
*/
public void testHead()
{
sink.head();
sink.head_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getHeadBlock();
assertEquals( "Wrong head!", expected, actual );
}
/**
* Checks that the sequence [body(), body_()],
* invoked on the current sink, produces the same result as
* {@link #getBodyBlock getBodyBlock()}.
*/
public void testBody()
{
sink.body();
sink.body_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getBodyBlock();
assertEquals( "Wrong body!", expected, actual );
}
/**
* Checks that the sequence [sectionTitle(), text( title ),
* sectionTitle_()], invoked on the current sink, produces
* the same result as
* {@link #getSectionTitleBlock getSectionTitleBlock}( title ).
*/
public void testSectionTitle()
{
String title = "Title";
sink.sectionTitle();
sink.text( title );
sink.sectionTitle_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getSectionTitleBlock( title );
assertEquals( "Wrong sectionTitle!", expected, actual );
}
/**
* Checks that the sequence [section1(), sectionTitle1(),
* text( title ), sectionTitle1_(), section1_()],
* invoked on the current sink, produces the same result as
* {@link #getSection1Block getSection1Block}( title ).
*/
public void testSection1()
{
String title = "Title1";
sink.section1();
sink.sectionTitle1();
sink.text( title );
sink.sectionTitle1_();
sink.section1_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getSection1Block( title );
assertEquals( "Wrong section1 block!", expected, actual );
}
/**
* Checks that the sequence [section2(), sectionTitle2(),
* text( title ), sectionTitle2_(), section2_()],
* invoked on the current sink, produces the same result as
* {@link #getSection2Block getSection2Block}( title ).
*/
public void testSection2()
{
String title = "Title2";
sink.section2();
sink.sectionTitle2();
sink.text( title );
sink.sectionTitle2_();
sink.section2_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getSection2Block( title );
assertEquals( "Wrong section2 block!", expected, actual );
}
/**
* Checks that the sequence [section3(), sectionTitle3(),
* text( title ), sectionTitle3_(), section3_()],
* invoked on the current sink, produces the same result as
* {@link #getSection3Block getSection3Block}( title ).
*/
public void testSection3()
{
String title = "Title3";
sink.section3();
sink.sectionTitle3();
sink.text( title );
sink.sectionTitle3_();
sink.section3_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getSection3Block( title );
assertEquals( "Wrong section3 block!", expected, actual );
}
/**
* Checks that the sequence [section4(), sectionTitle4(),
* text( title ), sectionTitle4_(), section4_()],
* invoked on the current sink, produces the same result as
* {@link #getSection4Block getSection4Block}( title ).
*
*/
public void testSection4()
{
String title = "Title4";
sink.section4();
sink.sectionTitle4();
sink.text( title );
sink.sectionTitle4_();
sink.section4_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getSection4Block( title );
assertEquals( "Wrong section4 block!", expected, actual );
}
/**
* Checks that the sequence [section5(), sectionTitle5(),
* text( title ), sectionTitle5_(), section5_()],
* invoked on the current sink, produces the same result as
* {@link #getSection5Block getSection5Block}( title ).
*/
public void testSection5()
{
String title = "Title5";
sink.section5();
sink.sectionTitle5();
sink.text( title );
sink.sectionTitle5_();
sink.section5_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getSection5Block( title );
assertEquals( "Wrong section5 block!", expected, actual );
}
/**
* Checks that the sequence [list(), listItem(), text( item ),
* listItem_(), list_()], invoked on the current sink, produces
* the same result as {@link #getListBlock getListBlock}( item ).
*
*/
public void testList()
{
String item = "list_item";
sink.list();
sink.listItem();
sink.text( item );
sink.listItem_();
sink.list_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getListBlock( item );
assertEquals( "Wrong list!", expected, actual );
}
/**
* Checks that the sequence
* [numberedList( Sink.NUMBERING_LOWER_ROMAN ), numberedListItem(),
* text( item ), numberedListItem_(), numberedList_()],
* invoked on the current sink, produces the same result as
* {@link #getNumberedListBlock getNumberedListBlock}( item ).
*/
public void testNumberedList()
{
String item = "numbered_list_item";
sink.numberedList( Sink.NUMBERING_LOWER_ROMAN );
sink.numberedListItem();
sink.text( item );
sink.numberedListItem_();
sink.numberedList_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getNumberedListBlock( item );
assertEquals( "Wrong numbered list!", expected, actual );
}
/**
* Checks that the sequence [definitionList(), definitionListItem(),
* definedTerm(), text( definum ), definedTerm_(), definition(),
* text( definition ), definition_(), definitionListItem_(),
* definitionList_()], invoked on the current sink, produces the same
* result as {@link #getDefinitionListBlock getDefinitionListBlock}
* ( definum, definition ).
*/
public void testDefinitionList()
{
String definum = "definum";
String definition = "definition";
sink.definitionList();
sink.definitionListItem();
sink.definedTerm();
sink.text( definum );
sink.definedTerm_();
sink.definition();
sink.text( definition );
sink.definition_();
sink.definitionListItem_();
sink.definitionList_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getDefinitionListBlock( definum, definition );
assertEquals( "Wrong definition list!", expected, actual );
}
/**
* Checks that the sequence [figure(), figureGraphics( source ),
* figureCaption(), text( caption ), figureCaption_(), figure_()],
* invoked on the current sink, produces the same result as
* {@link #getFigureBlock getFigureBlock}( source, caption ).
*/
public void testFigure()
{
String source = "figure.jpg";
String caption = "Figure_caption";
sink.figure();
sink.figureGraphics( source );
sink.figureCaption();
sink.text( caption );
sink.figureCaption_();
sink.figure_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getFigureBlock( source, caption );
assertEquals( "Wrong figure!", expected, actual );
}
/**
* Checks that the sequence [table(),
* tableRows( Sink.JUSTIFY_CENTER, false ), tableRow(), tableCell(),
* text( cell ), tableCell_(), tableRow_(), tableRows_(), tableCaption(),
* text( caption ), tableCaption_(), table_()],
* invoked on the current sink, produces the same result as
* {@link #getTableBlock getTableBlock}( cell, caption ).
*/
public void testTable()
{
String cell = "cell";
String caption = "Table_caption";
int[] justify = { Sink.JUSTIFY_CENTER };
sink.table();
sink.tableRows( justify, false );
sink.tableRow();
sink.tableCell();
sink.text( cell );
sink.tableCell_();
sink.tableRow_();
sink.tableRows_();
sink.tableCaption();
sink.text( caption );
sink.tableCaption_();
sink.table_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getTableBlock( cell, caption );
assertEquals( "Wrong table!", expected, actual );
}
/**
* Checks that the sequence [paragraph(), text( text ),
* paragraph_()], invoked on the current sink, produces
* the same result as {@link #getParagraphBlock getParagraphBlock}( text ).
*/
public void testParagraph()
{
String text = "Text";
sink.paragraph();
sink.text( text );
sink.paragraph_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getParagraphBlock( text );
assertEquals( "Wrong paragraph!", expected, actual );
}
/**
* Checks that the sequence [verbatim( SinkEventAttributeSet.BOXED ), text( text ),
* verbatim_()], invoked on the current sink, produces the
* same result as {@link #getVerbatimBlock getVerbatimBlock}( text ).
*/
public void testVerbatim()
{
String text = "Text";
sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( text );
sink.verbatim_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getVerbatimBlock( text );
assertEquals( "Wrong verbatim!", expected, actual );
}
/**
* Checks that the sequence [horizontalRule()],
* invoked on the current sink, produces the same result as
* {@link #getHorizontalRuleBlock getHorizontalRuleBlock()}.
*/
public void testHorizontalRule()
{
sink.horizontalRule();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getHorizontalRuleBlock();
assertEquals( "Wrong horizontal rule!", expected, actual );
}
/**
* Checks that the sequence [pageBreak()],
* invoked on the current sink, produces the same result as
* {@link #getPageBreakBlock getPageBreakBlock()}.
*/
public void testPageBreak()
{
sink.pageBreak();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getPageBreakBlock();
assertEquals( "Wrong pageBreak!", expected, actual );
}
/**
* Checks that the sequence [anchor( anchor ), text( anchor ),
* anchor_()], invoked on the current sink, produces the same
* result as {@link #getAnchorBlock getAnchorBlock}( anchor ).
*/
public void testAnchor()
{
String anchor = "Anchor";
sink.anchor( anchor );
sink.text( anchor );
sink.anchor_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getAnchorBlock( anchor );
assertEquals( "Wrong anchor!", expected, actual );
}
/**
* Checks that the sequence [link( link ), text( text ),
* link_()], invoked on the current sink, produces the same
* result as {@link #getLinkBlock getLinkBlock}( link, text ).
*/
public void testLink()
{
String link = "#Link";
String text = "Text";
sink.link( link );
sink.text( text );
sink.link_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getLinkBlock( link, text );
assertEquals( "Wrong link!", expected, actual );
}
/**
* Checks that the sequence [italic(), text( text ), italic_()],
* invoked on the current sink, produces the same result as
* {@link #getItalicBlock getItalicBlock}( text ).
*/
public void testItalic()
{
String text = "Italic";
sink.italic();
sink.text( text );
sink.italic_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getItalicBlock( text );
assertEquals( "Wrong italic!", expected, actual );
}
/**
* Checks that the sequence [bold(), text( text ), bold_()],
* invoked on the current sink, produces the same result as
* {@link #getBoldBlock getBoldBlock}( text ).
*/
public void testBold()
{
String text = "Bold";
sink.bold();
sink.text( text );
sink.bold_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getBoldBlock( text );
assertEquals( "Wrong bold!", expected, actual );
}
/**
* Checks that the sequence [monospaced(), text( text ),
* monospaced_()], invoked on the current sink, produces the same
* result as {@link #getMonospacedBlock getMonospacedBlock}( text ).
*/
public void testMonospaced()
{
String text = "Monospaced";
sink.monospaced();
sink.text( text );
sink.monospaced_();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getMonospacedBlock( text );
assertEquals( "Wrong monospaced!", expected, actual );
}
/**
* Checks that the sequence [lineBreak()],
* invoked on the current sink, produces the same result as
* {@link #getLineBreakBlock getLineBreakBlock()}.
*/
public void testLineBreak()
{
sink.lineBreak();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getLineBreakBlock();
assertEquals( "Wrong lineBreak!", expected, actual );
}
/**
* Checks that the sequence [nonBreakingSpace()],
* invoked on the current sink, produces the same result as
* {@link #getNonBreakingSpaceBlock getNonBreakingSpaceBlock()}.
*/
public void testNonBreakingSpace()
{
sink.nonBreakingSpace();
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getNonBreakingSpaceBlock();
assertEquals( "Wrong nonBreakingSpace!", expected, actual );
}
/**
* Checks that the sequence [text( text )],
* invoked on the current sink, produces the same result as
* {@link #getTextBlock getTextBlock()}.
*/
public void testText()
{
String text = "~,_=,_-,_+,_*,_[,_],_<,_>,_{,_},_\\";
sink.text( text );
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getTextBlock( text );
assertEquals( "Wrong text!", expected, actual );
}
/**
* Checks that the sequence [rawText( text )],
* invoked on the current sink, produces the same result as
* {@link #getRawTextBlock getRawTextBlock}( text ).
*/
public void testRawText()
{
String text = "~,_=,_-,_+,_*,_[,_],_<,_>,_{,_},_\\";
sink.rawText( text );
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getRawTextBlock( text );
assertEquals( "Wrong rawText!", expected, actual );
}
/**
* Checks that the sequence [comment(comment)],
* invoked on the current sink, produces the same result as
* {@link #getCommentBlock getCommentBlock}( comment ).
* @since 1.1.1
*/
public void testComment()
{
String comment = "Simple comment with ----";
sink.comment( comment );
sink.flush();
sink.close();
String actual = testWriter.toString();
String expected = getCommentBlock( comment );
assertEquals( "Wrong comment!", expected, actual );
}
// ----------------------------------------------------------------------
// Utility methods
// ----------------------------------------------------------------------
/**
* Returns the sink that is currently being tested.
* @return The current test sink.
*/
protected Sink getSink()
{
return sink;
}
/**
* Returns a String representation of all events that have been written to the sink.
* @return The Sink content as a String.
*/
protected String getSinkContent()
{
return testWriter.toString();
}
/**
* Returns the directory where all sink test output will go.
* @return The test output directory.
*/
protected String getOutputDir()
{
return "sink/";
}
// ----------------------------------------------------------------------
// Abstract methods the individual SinkTests must provide
// ----------------------------------------------------------------------
/**
* This method allows to use the correct Writer in {@link #testTestDocument()}.
*
* @return true if the Sink is an XML one, false otherwise.
* @see #testTestDocument()
*/
protected abstract boolean isXmlSink();
/**
* Return a new instance of the sink that is being tested.
* @param writer The writer for the sink.
* @return A new sink.
*/
protected abstract Sink createSink( Writer writer );
/**
* Returns a title block generated by this sink.
* @param title The title to use.
* @return The result of invoking a title block on the current sink.
* @see #testTitle()
*/
protected abstract String getTitleBlock( String title );
/**
* Returns an author block generated by this sink.
* @param author The author to use.
* @return The result of invoking an author block on the current sink.
* @see #testAuthor()
*/
protected abstract String getAuthorBlock( String author );
/**
* Returns a date block generated by this sink.
* @param date The date to use.
* @return The result of invoking a date block on the current sink.
* @see #testDate()
*/
protected abstract String getDateBlock( String date );
/**
* Returns a head block generated by this sink.
* @return The result of invoking a head block on the current sink.
* @see #testHead()
*/
protected abstract String getHeadBlock();
/**
* Returns a body block generated by this sink.
* @return The result of invoking a body block on the current sink.
* @see #testBody()
*/
protected abstract String getBodyBlock();
/**
* Returns a SectionTitle block generated by this sink.
* @param title The title to use.
* @return The result of invoking a SectionTitle block on the current sink.
* @see #testSectionTitle()
*/
protected abstract String getSectionTitleBlock( String title );
/**
* Returns a Section1 block generated by this sink.
* @param title The title to use.
* @return The result of invoking a Section1 block on the current sink.
* @see #testSection1()
*/
protected abstract String getSection1Block( String title );
/**
* Returns a Section2 block generated by this sink.
* @param title The title to use.
* @return The result of invoking a Section2 block on the current sink.
* @see #testSection2()
*/
protected abstract String getSection2Block( String title );
/**
* Returns a Section3 block generated by this sink.
* @param title The title to use.
* @return The result of invoking a Section3 block on the current sink.
* @see #testSection3()
*/
protected abstract String getSection3Block( String title );
/**
* Returns a Section4 block generated by this sink.
* @param title The title to use.
* @return The result of invoking a Section4 block on the current sink.
* @see #testSection4()
*/
protected abstract String getSection4Block( String title );
/**
* Returns a Section5 block generated by this sink.
* @param title The title to use.
* @return The result of invoking a Section5 block on the current sink.
* @see #testSection5()
*/
protected abstract String getSection5Block( String title );
/**
* Returns a list block generated by this sink.
* @param item The item to use.
* @return The result of invoking a list block on the current sink.
* @see #testList()
*/
protected abstract String getListBlock( String item );
/**
* Returns a NumberedList block generated by this sink.
* @param item The item to use.
* @return The result of invoking a NumberedList block on the current sink.
* @see #testNumberedList()
*/
protected abstract String getNumberedListBlock( String item );
/**
* Returns a DefinitionList block generated by this sink.
* @param definum The term to define.
* @param definition The definition.
* @return The result of invoking a DefinitionList block on the current sink.
* @see #testDefinitionList()
*/
protected abstract String getDefinitionListBlock( String definum,
String definition );
/**
* Returns a Figure block generated by this sink.
* @param source The figure source string.
* @param caption The caption to use (may be null).
* @return The result of invoking a Figure block on the current sink.
* @see #testFigure()
*/
protected abstract String getFigureBlock( String source, String caption );
/**
* Returns a Table block generated by this sink.
* @param cell A tabel cell to use.
* @param caption The caption to use (may be null).
* @return The result of invoking a Table block on the current sink.
* @see #testTable()
*/
protected abstract String getTableBlock( String cell, String caption );
/**
* Returns a Paragraph block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Paragraph block on the current sink.
* @see #testParagraph()
*/
protected abstract String getParagraphBlock( String text );
/**
* Returns a Verbatim block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Verbatim block on the current sink.
* @see #testVerbatim()
*/
protected abstract String getVerbatimBlock( String text );
/**
* Returns a HorizontalRule block generated by this sink.
* @return The result of invoking a HorizontalRule block on the current sink.
* @see #testHorizontalRule()
*/
protected abstract String getHorizontalRuleBlock();
/**
* Returns a PageBreak block generated by this sink.
* @return The result of invoking a PageBreak block on the current sink.
* @see #testPageBreak()
*/
protected abstract String getPageBreakBlock();
/**
* Returns a Anchor block generated by this sink.
* @param anchor The anchor to use.
* @return The result of invoking a Anchor block on the current sink.
* @see #testAnchor()
*/
protected abstract String getAnchorBlock( String anchor );
/**
* Returns a Link block generated by this sink.
* @param link The link to use.
* @param text The link text.
* @return The result of invoking a Link block on the current sink.
* @see #testLink()
*/
protected abstract String getLinkBlock( String link, String text );
/**
* Returns a Italic block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Italic block on the current sink.
* @see #testItalic()
*/
protected abstract String getItalicBlock( String text );
/**
* Returns a Bold block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Bold block on the current sink.
* @see #testBold()
*/
protected abstract String getBoldBlock( String text );
/**
* Returns a Monospaced block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Monospaced block on the current sink.
* @see #testMonospaced()
*/
protected abstract String getMonospacedBlock( String text );
/**
* Returns a LineBreak block generated by this sink.
* @return The result of invoking a LineBreak block on the current sink.
* @see #testLineBreak()
*/
protected abstract String getLineBreakBlock();
/**
* Returns a NonBreakingSpace block generated by this sink.
* @return The result of invoking a NonBreakingSpace block
* on the current sink.
* @see #testNonBreakingSpace()
*/
protected abstract String getNonBreakingSpaceBlock();
/**
* Returns a Text block generated by this sink.
* @param text The text to use.
* @return The result of invoking a Text block on the current sink.
* @see #testText()
*/
protected abstract String getTextBlock( String text );
/**
* Returns a RawText block generated by this sink.
* @param text The text to use.
* @return The result of invoking a RawText block on the current sink.
* @see #testRawText()
*/
protected abstract String getRawTextBlock( String text );
/**
* Returns a comment block generated by this sink.
* @param text The text to use.
* @return The result of invoking a comment block on the current sink.
* @see #testComment()
* @since 1.1.1
*/
protected abstract String getCommentBlock( String text );
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/SinkEventAttributeSetTest.java 0000644 0001750 0001750 00000024427 11163507217 032453 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Enumeration;
import javax.swing.text.AttributeSet;
import junit.framework.TestCase;
/**
* Test SinkEventAttributeSet.
*
* @author ltheussl
*/
public class SinkEventAttributeSetTest extends TestCase
{
private SinkEventAttributeSet sinkEventAttributeSet;
/**
* @throws java.lang.Exception if any.
*/
protected void setUp()
throws Exception
{
super.setUp();
this.sinkEventAttributeSet = new SinkEventAttributeSet();
}
/**
* Test of constructors, of class SinkEventAttributeSet.
*/
public void testConstructor()
{
try
{
SinkEventAttributeSet aset = new SinkEventAttributeSet( new String[] {"key"} );
fail( "missing attribute value!" );
}
catch ( IllegalArgumentException e )
{
assertNotNull( e );
}
}
/**
* Test of isEmpty method, of class SinkEventAttributeSet.
*/
public void testIsEmpty()
{
assertTrue( sinkEventAttributeSet.isEmpty() );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertFalse( sinkEventAttributeSet.isEmpty() );
}
/**
* Test of getAttributeCount method, of class SinkEventAttributeSet.
*/
public void testGetAttributeCount()
{
assertEquals( 0, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.addAttribute( "name1", "value1" );
assertEquals( 1, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.removeAttribute( "name2" );
assertEquals( 1, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.removeAttribute( "name1" );
assertEquals( 0, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertEquals( 1, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.BOXED );
assertEquals( 1, sinkEventAttributeSet.getAttributeCount() );
sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.BOLD );
assertEquals( 0, sinkEventAttributeSet.getAttributeCount() );
}
/**
* Test of isDefined method, of class SinkEventAttributeSet.
*/
public void testIsDefined()
{
assertFalse( sinkEventAttributeSet.isDefined( SinkEventAttributes.DECORATION ) );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOXED );
assertTrue( sinkEventAttributeSet.isDefined( SinkEventAttributes.DECORATION ) );
}
/**
* Test of isEqual method, of class SinkEventAttributeSet.
*/
public void testIsEqual()
{
SinkEventAttributes instance = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertTrue( instance.isEqual( sinkEventAttributeSet ) );
instance.addAttributes( SinkEventAttributeSet.BOXED );
assertFalse( instance.isEqual( sinkEventAttributeSet ) );
}
/**
* Test of equals method, of class SinkEventAttributeSet.
*/
public void testEquals()
{
assertFalse( sinkEventAttributeSet.equals( null ) );
assertTrue( sinkEventAttributeSet.equals( sinkEventAttributeSet ) );
SinkEventAttributes instance = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
assertTrue( instance.equals( sinkEventAttributeSet ) );
instance.addAttributes( SinkEventAttributeSet.BOXED );
assertFalse( instance.equals( sinkEventAttributeSet ) );
}
/**
* Test of copyAttributes method, of class SinkEventAttributeSet.
*/
public void testCopyAttributes()
{
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.ITALIC );
AttributeSet instance = sinkEventAttributeSet.copyAttributes();
assertTrue( instance.isEqual( sinkEventAttributeSet ) );
}
/**
* Test of getAttributeNames method, of class SinkEventAttributeSet.
*/
public void testGetAttributeNames()
{
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.UNDERLINE );
Enumeration result = sinkEventAttributeSet.getAttributeNames();
assertEquals( "decoration", result.nextElement() );
assertFalse( result.hasMoreElements() );
}
/**
* Test of getAttribute method, of class SinkEventAttributeSet.
*/
public void testGetAttribute()
{
sinkEventAttributeSet.addAttribute( "key", "value" );
assertTrue( sinkEventAttributeSet.getAttribute( "key" ).equals( "value" ) );
assertNull( sinkEventAttributeSet.getAttribute( "bla" ) );
}
/**
* Test of containsAttribute method, of class SinkEventAttributeSet.
*/
public void testContainsAttribute()
{
sinkEventAttributeSet.addAttribute( "key", "value" );
assertTrue( sinkEventAttributeSet.containsAttribute( "key", "value" ) );
assertFalse( sinkEventAttributeSet.containsAttribute( "key", "valu" ) );
}
/**
* Test of containsAttributes method, of class SinkEventAttributeSet.
*/
public void testContainsAttributes()
{
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.JUSTIFY );
assertTrue( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
assertFalse( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.BOXED ) );
}
/**
* Test of addAttribute method, of class SinkEventAttributeSet.
*/
public void testAddAttribute()
{
assertFalse( sinkEventAttributeSet.containsAttribute( "key", "value" ) );
sinkEventAttributeSet.addAttribute( "key", "value" );
assertTrue( sinkEventAttributeSet.containsAttribute( "key", "value" ) );
sinkEventAttributeSet.removeAttribute( "key" );
assertFalse( sinkEventAttributeSet.containsAttribute( "key", "value" ) );
}
/**
* Test of add/removeAttributes methods, of class SinkEventAttributeSet.
*/
public void testAddAttributes()
{
assertFalse( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.JUSTIFY );
assertTrue( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.JUSTIFY );
assertFalse( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.JUSTIFY );
sinkEventAttributeSet.removeAttributes( SinkEventAttributeSet.JUSTIFY.getAttributeNames() );
assertFalse( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.JUSTIFY );
assertTrue( sinkEventAttributeSet.containsAttributes( SinkEventAttributeSet.JUSTIFY ) );
sinkEventAttributeSet.removeAttributes( (AttributeSet) null ); // should do nothing
}
/**
* Test of getResolveParent method, of class SinkEventAttributeSet.
*/
public void testGetResolveParent()
{
assertNull( sinkEventAttributeSet.getResolveParent() );
sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.CENTER );
assertNotNull( sinkEventAttributeSet.getResolveParent() );
}
/**
* Test of clone method, of class SinkEventAttributeSet.
*/
public void testClone()
{
Object result = sinkEventAttributeSet.clone();
assertTrue( sinkEventAttributeSet.equals( result ) );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.MONOSPACED );
assertFalse( sinkEventAttributeSet.equals( result ) );
result = sinkEventAttributeSet.clone();
assertTrue( sinkEventAttributeSet.equals( result ) );
sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.CENTER );
//assertFalse( sinkEventAttributeSet.equals( result ) );
result = sinkEventAttributeSet.clone();
assertTrue( sinkEventAttributeSet.equals( result ) );
sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.BOXED );
//assertFalse( sinkEventAttributeSet.equals( result ) );
}
/**
* Test of hashCode method, of class SinkEventAttributeSet.
*/
public void testHashCode()
{
int oldValue = sinkEventAttributeSet.hashCode();
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOLD );
int newValue = sinkEventAttributeSet.hashCode();
assertFalse( oldValue == newValue );
oldValue = newValue;
sinkEventAttributeSet.setResolveParent( SinkEventAttributeSet.CENTER );
newValue = sinkEventAttributeSet.hashCode();
assertFalse( oldValue == newValue );
}
/**
* Test of toString method, of class SinkEventAttributeSet.
*/
public void testToString()
{
String expected = "";
assertEquals( expected, sinkEventAttributeSet.toString() );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.BOXED );
expected = " decoration=boxed";
assertEquals( expected, sinkEventAttributeSet.toString() );
sinkEventAttributeSet.addAttributes( SinkEventAttributeSet.CENTER );
expected = " decoration=boxed align=center";
assertEquals( expected, sinkEventAttributeSet.toString() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/TextSink.java 0000644 0001750 0001750 00000037475 11117204530 027114 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.Writer;
/**
* A simple text-based implementation of the Sink interface.
* Useful for testing purposes.
*/
public class TextSink
extends AbstractSink
{
/** For writing the result. */
private final Writer out;
/** Constructor.
* @param writer The writer for writing the result.
*/
public TextSink( Writer writer )
{
this.out = writer;
}
/** {@inheritDoc} */
public void head()
{
writeln( "begin:head" );
}
/** {@inheritDoc} */
public void head_()
{
writeln( "end:head" );
}
/** {@inheritDoc} */
public void body()
{
writeln( "begin:body" );
}
/** {@inheritDoc} */
public void body_()
{
writeln( "end:body" );
}
/** {@inheritDoc} */
public void section1()
{
write( "begin:section1" );
}
/** {@inheritDoc} */
public void section1_()
{
writeln( "end:section1" );
}
/** {@inheritDoc} */
public void section2()
{
write( "begin:section2" );
}
/** {@inheritDoc} */
public void section2_()
{
writeln( "end:section2" );
}
/** {@inheritDoc} */
public void section3()
{
write( "begin:section3" );
}
/** {@inheritDoc} */
public void section3_()
{
writeln( "end:section3" );
}
/** {@inheritDoc} */
public void section4()
{
write( "begin:section4" );
}
/** {@inheritDoc} */
public void section4_()
{
writeln( "end:section4" );
}
/** {@inheritDoc} */
public void section5()
{
write( "begin:section5" );
}
/** {@inheritDoc} */
public void section5_()
{
writeln( "end:section5" );
}
/** {@inheritDoc} */
public void list()
{
writeln( "begin:list" );
}
/** {@inheritDoc} */
public void list_()
{
writeln( "end:list" );
}
/** {@inheritDoc} */
public void listItem()
{
write( "begin:listItem" );
}
/** {@inheritDoc} */
public void listItem_()
{
writeln( "end:listItem" );
}
/** {@inheritDoc} */
public void numberedList( int numbering )
{
writeln( "begin:numberedList, numbering: " + numbering );
}
/** {@inheritDoc} */
public void numberedList_()
{
writeln( "end:numberedList" );
}
/** {@inheritDoc} */
public void numberedListItem()
{
write( "begin:numberedListItem" );
}
/** {@inheritDoc} */
public void numberedListItem_()
{
writeln( "end:numberedListItem" );
}
/** {@inheritDoc} */
public void definitionList()
{
writeln( "begin:definitionList" );
}
/** {@inheritDoc} */
public void definitionList_()
{
writeln( "end:definitionList" );
}
/** {@inheritDoc} */
public void definitionListItem()
{
write( "begin:definitionListItem" );
}
/** {@inheritDoc} */
public void definitionListItem_()
{
writeln( "end:definitionListItem" );
}
/** {@inheritDoc} */
public void definition()
{
write( "begin:definition" );
}
/** {@inheritDoc} */
public void definition_()
{
writeln( "end:definition" );
}
/** {@inheritDoc} */
public void figure()
{
write( "begin:figure" );
}
/** {@inheritDoc} */
public void figure_()
{
writeln( "end:figure" );
}
/** {@inheritDoc} */
public void table()
{
writeln( "begin:table" );
}
/** {@inheritDoc} */
public void table_()
{
writeln( "end:table" );
}
/** {@inheritDoc} */
public void tableRows( int[] justification, boolean grid )
{
writeln( "begin:tableRows" );
}
/** {@inheritDoc} */
public void tableRows_()
{
writeln( "end:tableRows" );
}
/** {@inheritDoc} */
public void tableRow()
{
write( "begin:tableRow" );
}
/** {@inheritDoc} */
public void tableRow_()
{
writeln( "end:tableRow" );
}
/** {@inheritDoc} */
public void title()
{
write( "begin:title" );
}
/** {@inheritDoc} */
public void title_()
{
writeln( "end:title" );
}
/** {@inheritDoc} */
public void author()
{
write( "begin:author" );
}
/** {@inheritDoc} */
public void author_()
{
writeln( "end:author" );
}
/** {@inheritDoc} */
public void date()
{
write( "begin:date" );
}
/** {@inheritDoc} */
public void date_()
{
writeln( "end:date" );
}
/** {@inheritDoc} */
public void sectionTitle()
{
write( "begin:sectionTitle" );
}
/** {@inheritDoc} */
public void sectionTitle_()
{
writeln( "end:sectionTitle" );
}
/** {@inheritDoc} */
public void sectionTitle1()
{
write( "begin:sectionTitle1" );
}
/** {@inheritDoc} */
public void sectionTitle1_()
{
writeln( "end:sectionTitle1" );
}
/** {@inheritDoc} */
public void sectionTitle2()
{
write( "begin:sectionTitle2" );
}
/** {@inheritDoc} */
public void sectionTitle2_()
{
writeln( "end:sectionTitle2" );
}
/** {@inheritDoc} */
public void sectionTitle3()
{
write( "begin:sectionTitle3" );
}
/** {@inheritDoc} */
public void sectionTitle3_()
{
writeln( "end:sectionTitle3" );
}
/** {@inheritDoc} */
public void sectionTitle4()
{
write( "begin:sectionTitle4" );
}
/** {@inheritDoc} */
public void sectionTitle4_()
{
writeln( "end:sectionTitle4" );
}
/** {@inheritDoc} */
public void sectionTitle5()
{
write( "begin:sectionTitle5" );
}
/** {@inheritDoc} */
public void sectionTitle5_()
{
writeln( "end:sectionTitle5" );
}
/** {@inheritDoc} */
public void paragraph()
{
write( "begin:paragraph" );
}
/** {@inheritDoc} */
public void paragraph_()
{
writeln( "end:paragraph" );
}
/** {@inheritDoc} */
public void verbatim( boolean boxed )
{
write( "begin:verbatim, boxed: " + boxed );
}
/** {@inheritDoc} */
public void verbatim_()
{
writeln( "end:verbatim" );
}
/** {@inheritDoc} */
public void definedTerm()
{
write( "begin:definedTerm" );
}
/** {@inheritDoc} */
public void definedTerm_()
{
writeln( "end:definedTerm" );
}
/** {@inheritDoc} */
public void figureCaption()
{
write( "begin:figureCaption" );
}
/** {@inheritDoc} */
public void figureCaption_()
{
writeln( "end:figureCaption" );
}
/** {@inheritDoc} */
public void tableCell()
{
write( "begin:tableCell" );
}
/** {@inheritDoc} */
public void tableCell( String width )
{
write( "begin:tableCell, width: " + width );
}
/** {@inheritDoc} */
public void tableCell_()
{
writeln( "end:tableCell" );
}
/** {@inheritDoc} */
public void tableHeaderCell()
{
write( "begin:tableHeaderCell" );
}
/** {@inheritDoc} */
public void tableHeaderCell( String width )
{
write( "begin:tableHeaderCell, width: " + width );
}
/** {@inheritDoc} */
public void tableHeaderCell_()
{
writeln( "end:tableHeaderCell" );
}
/** {@inheritDoc} */
public void tableCaption()
{
write( "begin:tableCaption" );
}
/** {@inheritDoc} */
public void tableCaption_()
{
writeln( "end:tableCaption" );
}
/** {@inheritDoc} */
public void figureGraphics( String name )
{
write( "figureGraphics, name: " + name );
}
/** {@inheritDoc} */
public void horizontalRule()
{
write( "horizontalRule" );
}
/** {@inheritDoc} */
public void pageBreak()
{
write( "pageBreak" );
}
/** {@inheritDoc} */
public void anchor( String name )
{
write( "begin:anchor, name: " + name );
}
/** {@inheritDoc} */
public void anchor_()
{
writeln( "end:anchor" );
}
/** {@inheritDoc} */
public void link( String name )
{
write( "begin:link, name: " + name );
}
/** {@inheritDoc} */
public void link_()
{
writeln( "end:link" );
}
/** {@inheritDoc} */
public void italic()
{
write( "begin:italic" );
}
/** {@inheritDoc} */
public void italic_()
{
writeln( "end:italic" );
}
/** {@inheritDoc} */
public void bold()
{
write( "begin:bold" );
}
/** {@inheritDoc} */
public void bold_()
{
writeln( "end:bold" );
}
/** {@inheritDoc} */
public void monospaced()
{
write( "begin:monospaced" );
}
/** {@inheritDoc} */
public void monospaced_()
{
writeln( "end:monospaced" );
}
/** {@inheritDoc} */
public void lineBreak()
{
write( "lineBreak" );
}
/** {@inheritDoc} */
public void nonBreakingSpace()
{
write( "nonBreakingSpace" );
}
/** {@inheritDoc} */
public void text( String text )
{
write( "text: " + text );
}
/** {@inheritDoc} */
public void rawText( String text )
{
write( "rawText: " + text );
}
/** {@inheritDoc} */
public void comment( String comment )
{
write( "comment: " + comment );
}
/** {@inheritDoc} */
public void flush()
{
try
{
out.flush();
}
catch ( IOException e )
{
getLog().warn( "Could not flush sink: " + e.getMessage(), e );
}
}
/** {@inheritDoc} */
public void close()
{
try
{
out.close();
}
catch ( IOException e )
{
getLog().warn( "Could not close sink: " + e.getMessage(), e );
}
}
/** {@inheritDoc} */
public void head( SinkEventAttributes attributes )
{
head();
}
/** {@inheritDoc} */
public void title( SinkEventAttributes attributes )
{
title();
}
/** {@inheritDoc} */
public void author( SinkEventAttributes attributes )
{
author();
}
/** {@inheritDoc} */
public void date( SinkEventAttributes attributes )
{
date();
}
/** {@inheritDoc} */
public void body( SinkEventAttributes attributes )
{
body();
}
/** {@inheritDoc} */
public void section( int level, SinkEventAttributes attributes )
{
write( "begin:section" + level );
}
/** {@inheritDoc} */
public void section_( int level )
{
writeln( "end:section" + level );
}
/** {@inheritDoc} */
public void sectionTitle( int level, SinkEventAttributes attributes )
{
write( "begin:sectionTitle" + level );
}
/** {@inheritDoc} */
public void sectionTitle_( int level )
{
writeln( "end:sectionTitle" + level );
}
/** {@inheritDoc} */
public void list( SinkEventAttributes attributes )
{
list();
}
/** {@inheritDoc} */
public void listItem( SinkEventAttributes attributes )
{
listItem();
}
/** {@inheritDoc} */
public void numberedList( int numbering, SinkEventAttributes attributes )
{
numberedList( numbering );
}
/** {@inheritDoc} */
public void numberedListItem( SinkEventAttributes attributes )
{
numberedListItem();
}
/** {@inheritDoc} */
public void definitionList( SinkEventAttributes attributes )
{
definitionList();
}
/** {@inheritDoc} */
public void definitionListItem( SinkEventAttributes attributes )
{
definitionListItem();
}
/** {@inheritDoc} */
public void definition( SinkEventAttributes attributes )
{
definition();
}
/** {@inheritDoc} */
public void definedTerm( SinkEventAttributes attributes )
{
definedTerm();
}
/** {@inheritDoc} */
public void figure( SinkEventAttributes attributes )
{
write( "begin:figure" + SinkUtils.getAttributeString( attributes ) );
}
/** {@inheritDoc} */
public void figureCaption( SinkEventAttributes attributes )
{
figureCaption();
}
/** {@inheritDoc} */
public void figureGraphics( String src, SinkEventAttributes attributes )
{
figureGraphics( src );
}
/** {@inheritDoc} */
public void table( SinkEventAttributes attributes )
{
table();
}
/** {@inheritDoc} */
public void tableRow( SinkEventAttributes attributes )
{
tableRow();
}
/** {@inheritDoc} */
public void tableCell( SinkEventAttributes attributes )
{
tableCell();
}
/** {@inheritDoc} */
public void tableHeaderCell( SinkEventAttributes attributes )
{
tableHeaderCell();
}
/** {@inheritDoc} */
public void tableCaption( SinkEventAttributes attributes )
{
tableCaption();
}
/** {@inheritDoc} */
public void paragraph( SinkEventAttributes attributes )
{
paragraph();
}
/** {@inheritDoc} */
public void verbatim( SinkEventAttributes attributes )
{
boolean boxed = false;
if ( attributes != null && attributes.isDefined( SinkEventAttributes.DECORATION ) )
{
boxed = "boxed".equals(
attributes.getAttribute( SinkEventAttributes.DECORATION ).toString() );
}
verbatim( boxed );
}
/** {@inheritDoc} */
public void horizontalRule( SinkEventAttributes attributes )
{
horizontalRule();
}
/** {@inheritDoc} */
public void anchor( String name, SinkEventAttributes attributes )
{
anchor( name );
}
/** {@inheritDoc} */
public void link( String name, SinkEventAttributes attributes )
{
link( name );
}
/** {@inheritDoc} */
public void lineBreak( SinkEventAttributes attributes )
{
lineBreak();
}
/** {@inheritDoc} */
public void text( String text, SinkEventAttributes attributes )
{
text( text );
}
/** {@inheritDoc} */
public void unknown( String name, Object[] requiredParams, SinkEventAttributes attributes )
{
write( "unknown: " + name );
}
/**
* Writes the given string + EOL.
*
* @param text The text to write.
*/
private void write( String text )
{
try
{
out.write( text + EOL );
}
catch ( IOException e )
{
getLog().warn( "Could not write to sink: " + e.getMessage(), e );
}
}
/**
* Writes the given string + two EOLs.
*
* @param text The text to write.
*/
private void writeln( String text )
{
write( text );
write( EOL );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/AbstractSinkTestCase.java 0000644 0001750 0001750 00000011157 11151220275 031356 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.FileWriter;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Reader;
import java.io.Writer;
import org.apache.maven.doxia.parser.Parser;
import org.codehaus.plexus.PlexusTestCase;
/**
* @author Jason van Zyl
* @version $Id: AbstractSinkTestCase.java 747735 2009-02-25 10:43:09Z ltheussl $
* @since 1.0
*/
public abstract class AbstractSinkTestCase
extends PlexusTestCase
{
private Writer testWriter;
// ---------------------------------------------------------------------
// Test case
// ----------------------------------------------------------------------
/**
* Parses the test apt document (obtained via {@link #getTestReader()}) with the Parser returned
* by {@link #createParser()} into the Sink returned by {@link #createSink()}.
*
* @throws java.lang.Exception if anything goes wrong.
*/
public void testApt()
throws Exception
{
Parser parser = createParser();
parser.parse( getTestReader(), createSink() );
}
// ----------------------------------------------------------------------
// Abstract methods the individual SinkTests must provide
// ----------------------------------------------------------------------
/**
* Return the default extension of files created by the test Sink.
*
* @return the extension of files created by the test Sink.
* @see #createSink()
*/
protected abstract String outputExtension();
/**
* Return a Parser for testing.
*
* @return a test Parser.
*/
protected abstract Parser createParser();
/**
* Return a Sink for testing.
*
* @return a test Sink.
* @throws java.lang.Exception if the Sink cannot be constructed.
*/
protected abstract Sink createSink()
throws Exception;
// ----------------------------------------------------------------------
// Methods for creating the test reader and writer
// ----------------------------------------------------------------------
/**
* Returns a Writer to write a test output result. The Writer writes to a File
* "target/output/test. + extension", where extension is returned by
* {@link #outputExtension()}, in the current base directory.
*
* @return a Writer to write a test output result.
* @throws java.lang.Exception if the Writer cannot be constructed.
*/
protected Writer getTestWriter()
throws Exception
{
if ( testWriter == null )
{
File outputDirectory = new File( getBasedirFile(), "target/output" );
if ( !outputDirectory.exists() )
{
outputDirectory.mkdirs();
}
testWriter = new FileWriter( new File( outputDirectory, "test." + outputExtension() ) );
}
return testWriter;
}
/**
* Returns a Reader that gives access to a common test apt file.
*
* @return a Reader to access the test apt resource file.
* @throws java.lang.Exception if the Reader cannot be constructed.
*/
protected Reader getTestReader()
throws Exception
{
InputStream is = Thread.currentThread().getContextClassLoader().getResourceAsStream( "test.apt" );
InputStreamReader reader = new InputStreamReader( is );
return reader;
}
// ----------------------------------------------------------------------
// Utility methods
// ----------------------------------------------------------------------
/**
* Return the current base diretory as a File.
*
* @return the current base diretory as a File.
*/
public File getBasedirFile()
{
return new File( getBasedir() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/render/ 0000755 0001750 0001750 00000000000 11632765552 025761 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/render/RenderingContextTest.java 0000644 0001750 0001750 00000004350 11151220275 032730 0 ustar twerner twerner package org.apache.maven.doxia.sink.render;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import org.codehaus.plexus.PlexusTestCase;
/**
* @author olamy
* @since 20 oct. 07
* @version $Id: RenderingContextTest.java 747735 2009-02-25 10:43:09Z ltheussl $
*/
public class RenderingContextTest
extends PlexusTestCase
{
/**
* Test getRelativePath() with various file names.
*
* @throws java.lang.Exception if any.
*/
public void testFileNameWithDot()
throws Exception
{
File baseDir = new File( getBasedir() + File.separatorChar + "test" + File.separatorChar + "resources" );
String docName = "file.with.dot.in.name.xml";
RenderingContext renderingContext = new RenderingContext( baseDir, docName, "", "xml" );
assertEquals( "file.with.dot.in.name.html", renderingContext.getOutputName() );
assertEquals( ".", renderingContext.getRelativePath() );
docName = "index.xml.vm";
renderingContext = new RenderingContext( baseDir, docName, "", "xml" );
assertEquals( "index.html", renderingContext.getOutputName() );
assertEquals( ".", renderingContext.getRelativePath() );
docName = "download.apt.vm";
renderingContext = new RenderingContext( baseDir, docName, "", "apt" );
assertEquals( "download.html", renderingContext.getOutputName() );
assertEquals( ".", renderingContext.getRelativePath() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/sink/SinkUtilsTest.java 0000644 0001750 0001750 00000005755 11163507633 030137 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.AttributeSet;
import javax.swing.text.MutableAttributeSet;
import junit.framework.TestCase;
/**
*
* @author ltheussl
*/
public class SinkUtilsTest
extends TestCase
{
/**
* Test of getAttributeString method, of class SinkUtils.
*/
public void testGetAttributeString()
{
assertEquals( "", SinkUtils.getAttributeString( null ) );
AttributeSet att = new SinkEventAttributeSet( SinkEventAttributeSet.BOXED );
String expResult = " decoration=\"boxed\"";
String result = SinkUtils.getAttributeString( att );
assertEquals( expResult, result );
SinkEventAttributes at = new SinkEventAttributeSet( SinkEventAttributeSet.BOLD );
at.addAttributes( att );
expResult = " style=\"bold\" decoration=\"boxed\"";
result = SinkUtils.getAttributeString( at );
assertEquals( expResult, result );
att = new SinkEventAttributeSet( new String[] {"color", "red", "margin-left", "20px"} );
at = new SinkEventAttributeSet();
at.addAttribute( SinkEventAttributeSet.STYLE, att );
expResult = " style=\"color: red; margin-left: 20px\"";
result = SinkUtils.getAttributeString( at );
assertEquals( expResult, result );
}
/**
* Test of filterAttributes method, of class SinkUtils.
*/
public void testFilterAttributes()
{
assertNull( SinkUtils.filterAttributes( null, null ) );
AttributeSet attributes = new SinkEventAttributeSet( 1 );
String[] valids = null;
MutableAttributeSet result = SinkUtils.filterAttributes( attributes, valids );
assertEquals( 0, result.getAttributeCount() );
valids = new String[] {};
result = SinkUtils.filterAttributes( attributes, valids );
assertEquals( 0, result.getAttributeCount() );
result = SinkUtils.filterAttributes( SinkEventAttributeSet.BOLD, SinkUtils.SINK_BASE_ATTRIBUTES );
assertEquals( 1, result.getAttributeCount() );
result = SinkUtils.filterAttributes( SinkEventAttributeSet.CENTER, SinkUtils.SINK_BASE_ATTRIBUTES );
assertEquals( 0, result.getAttributeCount() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/xsd/ 0000755 0001750 0001750 00000000000 11632765553 024335 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/xsd/AbstractXmlValidatorTest.java 0000644 0001750 0001750 00000042312 11214730343 032115 0 ustar twerner twerner package org.apache.maven.doxia.xsd;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.io.Reader;
import java.io.StringReader;
import java.net.JarURLConnection;
import java.net.URL;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.jar.JarEntry;
import java.util.jar.JarFile;
import junit.framework.AssertionFailedError;
import org.apache.maven.doxia.parser.AbstractXmlParser;
import org.codehaus.plexus.PlexusTestCase;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.SelectorUtils;
import org.codehaus.plexus.util.xml.XmlUtil;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXNotRecognizedException;
import org.xml.sax.SAXNotSupportedException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.helpers.XMLReaderFactory;
/**
* Abstract class to validate XML files with DTD or XSD mainly for Doxia namespaces.
*
* @author Vincent Siveton
* @version $Id: AbstractXmlValidatorTest.java 784395 2009-06-13 14:00:03Z vsiveton $
* @since 1.0
*/
public abstract class AbstractXmlValidatorTest
extends PlexusTestCase
{
/** The vm line separator */
protected static final String EOL = System.getProperty( "line.separator" );
/** Simple cache mechanism to load test documents. */
private static final Map CACHE_DOXIA_TEST_DOCUMENTS = new Hashtable();
/** Maven resource in the doxia-test-docs-XXX.jar */
private static final String MAVEN_RESOURCE_PATH = "META-INF/maven/org.apache.maven.doxia/doxia-test-docs/";
/** XMLReader to validate xml file */
private XMLReader xmlReader;
/** {@inheritDoc} */
protected void setUp()
throws Exception
{
super.setUp();
}
/** {@inheritDoc} */
protected void tearDown()
throws Exception
{
super.tearDown();
xmlReader = null;
}
/**
* Validate tests documents with DTD or XSD using xerces.
*
* @throws Exception if any
* @see #addNamespaces(String)
* @see #getTestDocuments()
*/
public void testValidateFiles()
throws Exception
{
for ( Iterator it = getTestDocuments().entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
if ( getContainer().getLogger().isDebugEnabled() )
{
getContainer().getLogger().debug( "Validate '" + entry.getKey() + "'" );
}
List errors = parseXML( entry.getValue().toString() );
for ( Iterator it2 = errors.iterator(); it2.hasNext(); )
{
ErrorMessage error = (ErrorMessage) it2.next();
if ( isFailErrorMessage( error.getMessage() ) )
{
fail( entry.getKey() + EOL + error.toString() );
}
else
{
if ( getContainer().getLogger().isDebugEnabled() )
{
getContainer().getLogger().debug( entry.getKey() + EOL + error.toString() );
}
}
}
}
}
// ----------------------------------------------------------------------
// Protected methods
// ----------------------------------------------------------------------
/**
* @return a non null patterns to includes specific test files.
* @see AbstractXmlValidatorTest#getTestDocuments()
*/
protected abstract String[] getIncludes();
/**
* @param content xml content not null
* @return xml content with the wanted Doxia namespace
*/
protected abstract String addNamespaces( String content );
/**
* @return a map of test resources filtered by patterns from {@link #getIncludes()}.
* @throws IOException if any
* @see #getIncludes()
* @see #getAllTestDocuments()
*/
protected Map getTestDocuments()
throws IOException
{
if ( getIncludes() == null )
{
return Collections.EMPTY_MAP;
}
Map testDocs = getAllTestDocuments();
Map ret = new Hashtable();
ret.putAll( testDocs );
for ( Iterator it = testDocs.keySet().iterator(); it.hasNext(); )
{
String key = it.next().toString();
for ( int i = 0; i < getIncludes().length; i++ )
{
if ( !SelectorUtils.matchPath( getIncludes()[i], key.toLowerCase( Locale.ENGLISH ) ) )
{
ret.remove( key );
}
}
}
return ret;
}
/**
* Find test resources in the doxia-test-docs-XXX.jar or in an IDE project.
*
* @return a map of test resources defined as follow:
*
*
key, the full url of test documents,
* i.e. jar:file:/.../doxia-test-docs-XXX.jar!/path/to/resource
*
value, the content for the resource defined by the key
*
* @throws IOException if any
*/
protected static Map getAllTestDocuments()
throws IOException
{
if ( CACHE_DOXIA_TEST_DOCUMENTS != null && !CACHE_DOXIA_TEST_DOCUMENTS.isEmpty() )
{
return CACHE_DOXIA_TEST_DOCUMENTS;
}
URL testJar = AbstractXmlValidatorTest.class.getClassLoader().getResource( MAVEN_RESOURCE_PATH );
if ( testJar == null )
{
// maybe in an IDE project
testJar = AbstractXmlValidatorTest.class.getClassLoader().getResource( "doxia-site" );
if ( testJar == null )
{
throw new RuntimeException(
"Could not find the Doxia test documents artefact i.e. doxia-test-docs-XXX.jar" );
}
}
if ( testJar.toString().startsWith( "jar" ))
{
JarURLConnection conn = (JarURLConnection) testJar.openConnection();
JarFile jarFile = conn.getJarFile();
for ( Enumeration e = jarFile.entries(); e.hasMoreElements(); )
{
JarEntry entry = (JarEntry) e.nextElement();
if ( entry.getName().startsWith( "META-INF" ) )
{
continue;
}
if ( entry.isDirectory() )
{
continue;
}
InputStream in = null;
try
{
in = AbstractXmlValidatorTest.class.getClassLoader().getResource( entry.getName() ).openStream();
String content = IOUtil.toString( in, "UTF-8" );
CACHE_DOXIA_TEST_DOCUMENTS.put( "jar:" + conn.getJarFileURL() + "!/" + entry.getName(), content );
}
finally
{
IOUtil.close( in );
}
}
}
else
{
// IDE projects
File testDocsDir = new File( testJar.getFile() ).getParentFile();
List files = FileUtils.getFiles( testDocsDir, "**/*.*", FileUtils.getDefaultExcludesAsString(), true );
for ( Iterator it = files.iterator(); it.hasNext();)
{
File file = new File( it.next().toString() );
if ( file.getAbsolutePath().indexOf( "META-INF" ) != -1 )
{
continue;
}
Reader reader = null;
if ( XmlUtil.isXml( file ))
{
reader = ReaderFactory.newXmlReader( file );
}
else
{
reader = ReaderFactory.newReader( file, "UTF-8" );
}
String content = IOUtil.toString( reader );
CACHE_DOXIA_TEST_DOCUMENTS.put( file.toURI().toString(), content );
}
}
return CACHE_DOXIA_TEST_DOCUMENTS;
}
/**
* Filter fail message.
*
* @param message not null
* @return true if the given message will fail the test.
* @since 1.1.1
*/
protected boolean isFailErrorMessage( String message )
{
if ( message
.indexOf( "schema_reference.4: Failed to read schema document 'http://www.w3.org/2001/xml.xsd'" ) == -1
&& message.indexOf( "cvc-complex-type.4: Attribute 'alt' must appear on element 'img'." ) == -1
&& message.indexOf( "cvc-complex-type.2.4.a: Invalid content starting with element" ) == -1
&& message.indexOf( "cvc-complex-type.2.4.a: Invalid content was found starting with element" ) == -1
&& message.indexOf( "cvc-datatype-valid.1.2.1:" ) == -1 // Doxia allow space
&& message.indexOf( "cvc-attribute.3:" ) == -1 ) // Doxia allow space
{
return true;
}
return false;
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
private XMLReader getXMLReader()
{
if ( xmlReader == null )
{
try
{
xmlReader = XMLReaderFactory.createXMLReader( "org.apache.xerces.parsers.SAXParser" );
xmlReader.setFeature( "http://xml.org/sax/features/validation", true );
xmlReader.setFeature( "http://apache.org/xml/features/validation/schema", true );
xmlReader.setErrorHandler( new MessagesErrorHandler() );
xmlReader.setEntityResolver( new AbstractXmlParser.CachedFileEntityResolver() );
}
catch ( SAXNotRecognizedException e )
{
throw new AssertionFailedError( "SAXNotRecognizedException: " + e.getMessage() );
}
catch ( SAXNotSupportedException e )
{
throw new AssertionFailedError( "SAXNotSupportedException: " + e.getMessage() );
}
catch ( SAXException e )
{
throw new AssertionFailedError( "SAXException: " + e.getMessage() );
}
}
( (MessagesErrorHandler) xmlReader.getErrorHandler() ).clearMessages();
return xmlReader;
}
/**
* @param xmlContent
* @return a list of ErrorMessage
* @throws IOException is any
* @throws SAXException if any
*/
private List parseXML( String xmlContent )
throws IOException, SAXException
{
xmlContent = addNamespaces( xmlContent );
MessagesErrorHandler errorHandler = (MessagesErrorHandler) getXMLReader().getErrorHandler();
getXMLReader().parse( new InputSource( new StringReader( xmlContent ) ) );
return errorHandler.getMessages();
}
private static class ErrorMessage
extends DefaultHandler
{
private final String level;
private final String publicID;
private final String systemID;
private final int lineNumber;
private final int columnNumber;
private final String message;
public ErrorMessage( String level, String publicID, String systemID, int lineNumber, int columnNumber,
String message )
{
super();
this.level = level;
this.publicID = publicID;
this.systemID = systemID;
this.lineNumber = lineNumber;
this.columnNumber = columnNumber;
this.message = message;
}
/**
* @return the level
*/
protected String getLevel()
{
return level;
}
/**
* @return the publicID
*/
protected String getPublicID()
{
return publicID;
}
/**
* @return the systemID
*/
protected String getSystemID()
{
return systemID;
}
/**
* @return the lineNumber
*/
protected int getLineNumber()
{
return lineNumber;
}
/**
* @return the columnNumber
*/
protected int getColumnNumber()
{
return columnNumber;
}
/**
* @return the message
*/
protected String getMessage()
{
return message;
}
/** {@inheritDoc} */
public String toString()
{
StringBuffer sb = new StringBuffer();
sb.append( level ).append( EOL );
sb.append( " Public ID: " ).append( publicID ).append( EOL );
sb.append( " System ID: " ).append( systemID ).append( EOL );
sb.append( " Line number: " ).append( lineNumber ).append( EOL );
sb.append( " Column number: " ).append( columnNumber ).append( EOL );
sb.append( " Message: " ).append( message ).append( EOL );
return sb.toString();
}
/** {@inheritDoc} */
public int hashCode()
{
final int prime = 31;
int result = 1;
result = prime * result + columnNumber;
result = prime * result + ( ( level == null ) ? 0 : level.hashCode() );
result = prime * result + lineNumber;
result = prime * result + ( ( message == null ) ? 0 : message.hashCode() );
result = prime * result + ( ( publicID == null ) ? 0 : publicID.hashCode() );
result = prime * result + ( ( systemID == null ) ? 0 : systemID.hashCode() );
return result;
}
/** {@inheritDoc} */
public boolean equals( Object obj )
{
if ( this == obj )
return true;
if ( obj == null )
return false;
if ( getClass() != obj.getClass() )
return false;
ErrorMessage other = (ErrorMessage) obj;
if ( columnNumber != other.columnNumber )
return false;
if ( level == null )
{
if ( other.level != null )
return false;
}
else if ( !level.equals( other.level ) )
return false;
if ( lineNumber != other.lineNumber )
return false;
if ( message == null )
{
if ( other.message != null )
return false;
}
else if ( !message.equals( other.message ) )
return false;
if ( publicID == null )
{
if ( other.publicID != null )
return false;
}
else if ( !publicID.equals( other.publicID ) )
return false;
if ( systemID == null )
{
if ( other.systemID != null )
return false;
}
else if ( !systemID.equals( other.systemID ) )
return false;
return true;
}
}
private static class MessagesErrorHandler
extends DefaultHandler
{
private final List messages;
public MessagesErrorHandler()
{
messages = new ArrayList();
}
/** {@inheritDoc} */
public void warning( SAXParseException e )
throws SAXException
{
addMessage( "Warning", e );
}
/** {@inheritDoc} */
public void error( SAXParseException e )
throws SAXException
{
addMessage( "Error", e );
}
/** {@inheritDoc} */
public void fatalError( SAXParseException e )
throws SAXException
{
addMessage( "Fatal error", e );
}
private void addMessage( String pre, SAXParseException e )
{
ErrorMessage error =
new ErrorMessage( pre, e.getPublicId(), e.getSystemId(), e.getLineNumber(), e.getColumnNumber(),
e.getMessage() );
messages.add( error );
}
protected List getMessages()
{
return messages;
}
protected void clearMessages()
{
messages.clear();
}
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/index/ 0000755 0001750 0001750 00000000000 11632765553 024646 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/index/IndexEntryTest.java 0000644 0001750 0001750 00000005063 11166633050 030432 0 ustar twerner twerner package org.apache.maven.doxia.index;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import junit.framework.TestCase;
/**
* @author Trygve Laugstøl
* @version $Id: IndexEntryTest.java 762694 2009-04-07 11:16:56Z ltheussl $
*/
public class IndexEntryTest
extends TestCase
{
/**
* Test IndexEntry.
*/
public void testIndexEntry()
{
IndexEntry root = new IndexEntry( null );
assertIndexEntry( root, null, 0, null, null );
// -----------------------------------------------------------------------
// Chapter 1
// -----------------------------------------------------------------------
IndexEntry chapter1 = new IndexEntry( root, "chapter-1" );
assertIndexEntry( root, null, 1, null, null );
assertIndexEntry( chapter1, root, 0, null, null );
// -----------------------------------------------------------------------
// Chapter 2
// -----------------------------------------------------------------------
IndexEntry chapter2 = new IndexEntry( root, "chapter-2" );
assertIndexEntry( root, null, 2, null, null );
assertIndexEntry( chapter1, root, 0, null, chapter2 );
assertIndexEntry( chapter2, root, 0, chapter1, null );
chapter2.setTitle( "Title 2" );
assertTrue( chapter2.toString().indexOf( "Title 2" ) != -1 );
}
private void assertIndexEntry( IndexEntry entry, IndexEntry parent, int childCount,
IndexEntry prevEntry, IndexEntry nextEntry )
{
assertEquals( parent, entry.getParent() );
assertEquals( childCount, entry.getChildEntries().size() );
assertEquals( prevEntry, entry.getPrevEntry() );
assertEquals( nextEntry, entry.getNextEntry() );
}
}
doxia-1.1.4/doxia-core/src/site/ 0000755 0001750 0001750 00000000000 11632765554 016362 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/site/apt/ 0000755 0001750 0001750 00000000000 11632765554 017146 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/site/apt/using-document-xsd.apt 0000644 0001750 0001750 00000002736 11215435237 023406 0 ustar twerner twerner -----
Using Schema Document 1.0.1
-----
Vincent Siveton
------
2009-01-28
------
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Using Schema Document 1.0.1
The Decoration XSD is located {{{http://maven.apache.org/xsd/document-1.0.1.xsd}here}}.
Your favorite IDE probably supports XSD schema's for .xml files. You need to specify the following:
+-----+
...
+-----+
doxia-1.1.4/doxia-core/src/site/site.xml 0000644 0001750 0001750 00000002607 11140054106 020027 0 ustar twerner twerner
doxia-1.1.4/doxia-core/src/main/ 0000755 0001750 0001750 00000000000 11632765554 016342 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/mdo/ 0000755 0001750 0001750 00000000000 11632765553 017120 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/mdo/document.mdo 0000644 0001750 0001750 00000121455 11214045650 021430 0 ustar twerner twerner
documentDocumentThis is a reference for the Document model used in Doxia.
]]>packageorg.apache.maven.doxia.documentDocumentModelDescribes the overall document model.1.0.0+outputName1.0.0+Stringtruemeta1.0.0+DocumentMetatruetoc1.0.0+DocumentTOCtruecover1.0.0+DocumentCovertrueDocumentMeta
Metadata is general information about a document.
]]>1.0.0+title1.0.0+Stringtrueauthor1.0.0+Stringtrueauthors1.0.0+DocumentAuthor*truesubject1.0.0+Stringtruekeywords1.0.0+StringtruekeyWords1.0.0+String*truepageSize1.0.0+Stringtruegenerator1.0.0+Stringtruedescription1.0.0+StringtrueinitialCreator1.0.0+Stringtruecreator1.0.0+StringtrueprintedBy1.0.0+StringtruecreationDate1.0.0+Datetruecreationdate1.0.1+creationDate is not set.
@since 1.1.1
]]>Stringtruedate1.0.0+Datetruemodifydate1.0.1+date is not set.
@since 1.1.1
]]>StringtrueprintDate1.0.0+Datetrueprintdate1.0.1+printDate is not set.
@since 1.1.1
]]>Stringtruetemplate1.0.0+DocumentTemplatetruehyperlinkBehaviour1.0.0+DocumentHyperlinkBehaviourtruelanguage1.0.0+Stringen-UStrueeditingCycles1.0.0+longtrueeditingDuration1.0.0+longtruedocumentStatistic1.0.0+DocumentStatistictrueconfidential1.0.0+booleantruedraft1.0.0+booleantrue
0 )
{
java.util.StringTokenizer st = new java.util.StringTokenizer( getKeywords().trim(), "," );
while ( st.hasMoreTokens() )
{
String s = st.nextToken();
sb.append( s.trim() );
if ( st.hasMoreTokens() )
{
sb.append( ", " );
}
hasKeywords = true;
}
}
if ( getKeyWords() != null )
{
for ( java.util.Iterator it = getKeyWords().iterator(); it.hasNext(); )
{
String keyword = (String) it.next();
if ( hasKeywords )
{
sb.append( ", " );
hasKeywords = false;
}
if ( keyword.trim().length() > 0 )
{
sb.append( keyword.trim() );
if ( it.hasNext() )
{
sb.append( ", " );
}
}
}
}
String ret = sb.toString().trim();
if ( ret.endsWith( "," ) )
{
return ret.substring( 0, ret.length() - 1 );
}
return ret;
}
/**
* @return {@link #getAuthor()} if the unique author name is defined. Otherwise, return all authors full names
* comma separated.
* @see #getAuthor()
* @see #getAuthors()
* @since 1.1.1
*/
public String getAllAuthorNames()
{
StringBuffer sb = new StringBuffer();
if ( getAuthor() != null && getAuthor().trim().length() > 0 )
{
return getAuthor().trim();
}
if ( getAuthors() != null )
{
for ( java.util.Iterator it = getAuthors().iterator(); it.hasNext(); )
{
DocumentAuthor author = (DocumentAuthor) it.next();
sb.append( author.getFullName().trim() );
if ( it.hasNext() )
{
sb.append( ", " );
}
}
}
return sb.toString();
}
/** ISO 8601 date format, i.e. yyyy-MM-dd **/
private static final java.text.DateFormat ISO_8601_FORMAT = new java.text.SimpleDateFormat( "yyyy-MM-dd", java.util.Locale.ENGLISH );
/**
* Get the date and time when the document was created initially.
*
* @return the getCreationDate() if setted, formatted using ISO-8601 English format, otherwise return
* the creationdate.
* @since 1.1.1
* @see #getCreationDate()
*/
public String getCreationdate()
{
if ( getCreationDate() != null )
{
return ISO_8601_FORMAT.format( getCreationDate() );
}
return this.creationdate;
}
/**
* Get the date and time when the document was last modified.
*
* @return the getDate() if setted, formatted using ISO-8601 English format, otherwise return
* the modifydate.
* @since 1.1.1
* @see #getDate()
*/
public String getModifydate()
{
if ( getDate() != null )
{
return ISO_8601_FORMAT.format( getDate() );
}
return this.modifydate;
}
/**
* Get the date and time when the document was last printed.
*
* @return the getPrintDate() if setted, formatted using ISO-8601 English format, otherwise return
* the printdate.
* @since 1.1.1
* @see #getPrintDate()
*/
public String getPrintdate()
{
if ( getPrintDate() != null )
{
return ISO_8601_FORMAT.format( getPrintDate() );
}
return this.printdate;
}
]]>
DocumentAuthorAn author of the document.1.0.0+firstName1.0.0+StringtruelastName1.0.0+Stringtruename1.0.1+Stringtrueinitials1.0.0+Stringtruetitle1.0.0+Stringtrueposition1.0.0+Stringtrueemail1.0.0+StringtruephoneNumber1.0.0+StringtruefaxNumber1.0.0+StringtruecompanyName1.0.0+Stringtruestreet1.0.0+Stringtruecity1.0.0+StringtruepostalCode1.0.0+Stringtruecountry1.0.0+Stringtruestate1.0.0+Stringtrue
name if defined, firsName lastName otherwise.
* @see #getName()
* @see #getFirstName()
* @see #getLastName()
* @since 1.1.1
*/
public String getFullName()
{
if ( getName() != null && getName().trim().length() > 0 )
{
return getName().trim();
}
return ( getFirstName() != null ? getFirstName().trim() : "null" ) + " "
+ ( getLastName() != null ? getLastName().trim() : "null" );
}
]]>
DocumentTemplateA template that was used to create the document.1.0.0+href1.0.0+Stringtruetitle1.0.0+Stringtruedate1.0.0+Datetruemodifydate1.0.1+date is not set.
@since 1.1.1
]]>Stringtrue
yyyy-MM-dd **/
private static final java.text.DateFormat ISO_8601_FORMAT = new java.text.SimpleDateFormat( "yyyy-MM-dd", java.util.Locale.ENGLISH );
/**
* Get the date and time when the template was last modified.
*
* @return the getDate() if setted, formatted using ISO-8601 English format, otherwise return
* the modifydate.
* @since 1.1.1
* @see #getDate()
*/
public String getModifydate()
{
if ( getDate() != null )
{
return ISO_8601_FORMAT.format( getDate() );
}
return this.modifydate;
}
]]>
DocumentHyperlinkBehaviourSpecifies the default behavior for hyperlinks in the document.1.0.0+targetFrame
Specifies the name of the default target frame in which to display
a document referenced by a hyperlink.
This attribute can have one of the following values:
_self
The referenced document replaces the content
of the current frame.
_blank
The referenced document is displayed in a new frame.
_parent
The referenced document is displayed in the parent frame
of the current frame.
_top
The referenced document is displayed in the topmost frame,
that is the frame that contains the current frame as a child
or descendent but is not contained within another frame.
A frame name
The referenced document is displayed in the named frame.
If the named frame does not exist, a new frame with that
name is created.
]]>1.0.0+String_selftrueDocumentStatisticStatistical attributes of the document.1.0.0+pageCount1.0.0+longtruetableCount1.0.0+longtruedrawCount1.0.0+longtrueimageCount1.0.0+longtrueobjectCount1.0.0+longtrueoleObjectCount1.0.0+longtrueparagraphCount1.0.0+longtruewordCount1.0.0+longtruecharacterCount1.0.0+longtruerowCount1.0.0+longtrueframeCount1.0.0+longtruesentenceCount1.0.0+longtruesyllableCount1.0.0+longtruenonWhitespaceCharacterCount1.0.0+longtrueDocumentCoverContains meta-data information for the document cover page.1.0.0+coverTitle1.0.0+StringtruecoverSubTitle1.0.0+StringtruecoverVersion1.0.0+StringtruecoverType1.0.0+StringtruecoverDate1.0.0+DatetruecoverdatecoverDate is not set.
@since 1.1.1
]]>1.0.1+Stringtrueauthors1.0.0+DocumentAuthor*trueauthor1.0.1+StringtrueprojectName1.0.0+StringtrueprojectLogo1.0.0+StringtruecompanyName1.0.0+StringtruecompanyLogo1.0.0+Stringtrue
0 )
{
return getAuthor().trim();
}
if ( getAuthors() != null )
{
for ( java.util.Iterator it = getAuthors().iterator(); it.hasNext(); )
{
DocumentAuthor author = (DocumentAuthor) it.next();
sb.append( author.getFullName().trim() );
if ( it.hasNext() )
{
sb.append( ", " );
}
}
}
return sb.toString();
}
/** ISO 8601 date format, i.e. yyyy-MM-dd **/
private static final java.text.DateFormat ISO_8601_FORMAT = new java.text.SimpleDateFormat( "yyyy-MM-dd", java.util.Locale.ENGLISH );
/**
* Get the date to appear on the cover.
*
* @return the getCoverDate() if setted, formatted using ISO-8601 English format, otherwise return
* the coverdate.
* @since 1.1.1
* @see #getCoverDate()
*/
public String getCoverdate()
{
if ( getCoverDate() != null )
{
return ISO_8601_FORMAT.format( getCoverDate() );
}
return this.coverdate;
}
]]>
DocumentTOCA Table Of Content for the document.1.0.0+name1.0.0+Stringtruedepth1.0.0+inttrue0items1.0.0+DocumentTOCItem*trueDocumentTOCItemA menu item.1.0.0+name1.0.0+Stringtrueref1.0.0+Stringtruecollapse1.0.0+booleantrueitems1.0.0+DocumentTOCItem*true
doxia-1.1.4/doxia-core/src/main/javadoc/ 0000755 0001750 0001750 00000000000 11632765554 017751 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/javadoc/org/ 0000755 0001750 0001750 00000000000 11632765554 020540 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/javadoc/org/apache/ 0000755 0001750 0001750 00000000000 11632765554 021761 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/javadoc/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765554 023067 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/javadoc/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765554 024173 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/javadoc/org/apache/maven/doxia/package.html 0000644 0001750 0001750 00000011730 11216135717 026444 0 ustar twerner twerner
Maven Doxia API.
The Doxia API is based on Sinks and Parser objects: its goal is to parse a given source model
using a given parser, and emits Doxia events into the given sink.
Using Maven Doxia API
The following snippet shows how to use the Doxia API:
File userDir = new File( System.getProperty ( "user.dir" ) );
File inputFile = new File( userDir, "test.apt" );
File outputFile = new File( userDir, "test.html" );
doxia-1.1.4/doxia-core/src/main/java/ 0000755 0001750 0001750 00000000000 11632765553 017262 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765553 020051 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765553 021272 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765553 022400 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765554 023505 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/ 0000755 0001750 0001750 00000000000 11632765553 024605 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/ 0000755 0001750 0001750 00000000000 11632765553 026267 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetReader.java 0000644 0001750 0001750 00000013316 11375720354 031675 0 ustar twerner twerner package org.apache.maven.doxia.macro.snippet;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStreamReader;
import java.net.URL;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
import org.codehaus.plexus.util.IOUtil;
/**
* Utility class for reading snippets.
*
* @version $Id: SnippetReader.java 947273 2010-05-22 09:16:28Z ltheussl $
*/
public class SnippetReader
{
/** System-dependent EOL. */
private static final String EOL = System.getProperty( "line.separator" );
/** The source. */
private URL source;
/**
* Constructor.
*
* @param src The source.
*/
public SnippetReader( URL src )
{
this.source = src;
}
/**
* Reads the snippet with given id.
*
* @param snippetId The id of the snippet.
* @return The snippet.
* @throws java.io.IOException if something goes wrong.
*/
public StringBuffer readSnippet( String snippetId )
throws IOException
{
List lines = readLines( snippetId );
int minIndent = minIndent( lines );
StringBuffer result = new StringBuffer();
for ( Iterator iterator = lines.iterator(); iterator.hasNext(); )
{
String line = (String) iterator.next();
result.append( line.substring( minIndent ) );
result.append( EOL );
}
return result;
}
/**
* Returns the minimal indent of all the lines in the given List.
*
* @param lines A List of lines.
* @return the minimal indent.
*/
int minIndent( List lines )
{
int minIndent = Integer.MAX_VALUE;
for ( Iterator iterator = lines.iterator(); iterator.hasNext(); )
{
String line = (String) iterator.next();
minIndent = Math.min( minIndent, indent( line ) );
}
return minIndent;
}
/**
* Returns the indent of the given line.
*
* @param line A line.
* @return the indent.
*/
int indent( String line )
{
char[] chars = line.toCharArray();
int indent = 0;
for ( ; indent < chars.length; indent++ )
{
if ( chars[indent] != ' ' )
{
break;
}
}
return indent;
}
/**
* Reads the snippet and returns the lines in a List.
*
* @param snippetId The id of the snippet.
* @return A List of lines.
* @throws IOException if something goes wrong.
*/
private List readLines( String snippetId )
throws IOException
{
// TODO: DOXIA-386, use InputStreamReader(InputStream in, Charset cs)
BufferedReader reader = new BufferedReader( new InputStreamReader( source.openStream() ) );
List lines = new ArrayList();
try
{
boolean capture = false;
String line;
while ( ( line = reader.readLine() ) != null )
{
if ( snippetId == null || "".equals( snippetId.trim() ) )
{
lines.add( line );
}
else
{
if ( isStart( snippetId, line ) )
{
capture = true;
}
else if ( isEnd( snippetId, line ) )
{
break;
}
else if ( capture )
{
lines.add( line );
}
}
}
}
finally
{
IOUtil.close( reader );
}
return lines;
}
/**
* Determines if the given line is a start demarcator.
*
* @param snippetId the id of the snippet.
* @param line the line.
* @return True, if the line is a start demarcator.
*/
protected boolean isStart( String snippetId, String line )
{
return isDemarcator( snippetId, "START", line );
}
/**
* Determines if the given line is a demarcator.
*
* @param snippetId the id of the snippet.
* @param what Identifier for the demarcator.
* @param line the line.
* @return True, if the line is a start demarcator.
*/
protected boolean isDemarcator( String snippetId, String what, String line )
{
String upper = line.toUpperCase( Locale.ENGLISH );
return upper.indexOf( what.toUpperCase( Locale.ENGLISH ) ) != -1
&& upper.indexOf( "SNIPPET" ) != -1
&& line.indexOf( snippetId ) != -1;
}
/**
* Determines if the given line is an end demarcator.
*
* @param snippetId the id of the snippet.
* @param line the line.
* @return True, if the line is an end demarcator.
*/
protected boolean isEnd( String snippetId, String line )
{
return isDemarcator( snippetId, "END", line );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/snippet/SnippetMacro.java 0000644 0001750 0001750 00000017212 11151220275 031520 0 ustar twerner twerner package org.apache.maven.doxia.macro.snippet;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.macro.AbstractMacro;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
import java.io.IOException;
import java.io.File;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.HashMap;
import java.util.Map;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* A macro that prints out the content of a file or a URL.
*
* @plexus.component role-hint="snippet"
* @version $Id: SnippetMacro.java 747735 2009-02-25 10:43:09Z ltheussl $
*/
public class SnippetMacro
extends AbstractMacro
{
/** Holds the cache. */
private static Map cache = new HashMap();
private static final int HOUR = 60;
/** One hour default cache. */
private long timeout = HOUR * HOUR * 1000;
/** Holds the time cache. */
private static Map timeCached = new HashMap();
/** Debug. */
private boolean debug = false;
/** {@inheritDoc} */
public void execute( Sink sink, MacroRequest request )
throws MacroExecutionException
{
String id = (String) request.getParameter( "id" );
String urlParam = (String) request.getParameter( "url" );
String fileParam = (String) request.getParameter( "file" );
boolean verbatim = true;
String verbatimParam = (String) request.getParameter( "verbatim" );
if ( verbatimParam != null && !"".equals( verbatimParam ) )
{
verbatim = Boolean.valueOf( verbatimParam ).booleanValue();
}
URL url;
if ( !StringUtils.isEmpty( urlParam ) )
{
try
{
url = new URL( urlParam );
}
catch ( MalformedURLException e )
{
throw new IllegalArgumentException( urlParam + " is a malformed URL" );
}
}
else if ( !StringUtils.isEmpty( fileParam ) )
{
File f = new File( fileParam );
if ( !f.isAbsolute() )
{
f = new File( request.getBasedir(), fileParam );
}
try
{
url = f.toURI().toURL();
}
catch ( MalformedURLException e )
{
throw new IllegalArgumentException( fileParam + " is a malformed URL" );
}
}
else
{
throw new IllegalArgumentException( "Either the 'url' or the 'file' param has to be given." );
}
StringBuffer snippet;
try
{
snippet = getSnippet( url, id );
}
catch ( IOException e )
{
throw new MacroExecutionException( "Error reading snippet", e );
}
if ( verbatim )
{
sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( snippet.toString() );
sink.verbatim_();
}
else
{
sink.rawText( snippet.toString() );
}
}
/**
* Return a snippet of the given url.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @return The snippet.
* @throws IOException if something goes wrong.
*/
private StringBuffer getSnippet( URL url, String id )
throws IOException
{
StringBuffer result;
String cachedSnippet = (String) getCachedSnippet( url, id );
if ( cachedSnippet != null )
{
result = new StringBuffer( cachedSnippet );
if ( debug )
{
result.append( "(Served from cache)" );
}
}
else
{
result = new SnippetReader( url ).readSnippet( id );
cacheSnippet( url, id, result.toString() );
if ( debug )
{
result.append( "(Fetched from url, cache content " ).append( cache ).append( ")" );
}
}
return result;
}
/**
* Return a snippet from the cache.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @return The snippet.
*/
private Object getCachedSnippet( URL url, String id )
{
if ( isCacheTimedout( url, id ) )
{
removeFromCache( url, id );
}
return cache.get( globalSnippetId( url, id ) );
}
/**
* Return true if the snippet has been cached longer than
* the current timeout.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @return True if timeout exceeded.
*/
boolean isCacheTimedout( URL url, String id )
{
return timeInCache( url, id ) >= timeout;
}
/**
* Return the time the snippet has been cached.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @return The cache time.
*/
long timeInCache( URL url, String id )
{
return System.currentTimeMillis() - getTimeCached( url, id );
}
/**
* Return the absolute value of when the snippet has been cached.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @return The cache time.
*/
long getTimeCached( URL url, String id )
{
String globalId = globalSnippetId( url, id );
return timeCached.containsKey( globalId ) ? ( (Long) timeCached.get( globalId ) ).longValue() : 0;
}
/**
* Removes the snippet from the cache.
*
* @param url The URL to parse.
* @param id The id of the snippet.
*/
private void removeFromCache( URL url, String id )
{
String globalId = globalSnippetId( url, id );
timeCached.remove( globalId );
cache.remove( globalId );
}
/**
* Return a global identifier for the snippet.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @return An identifier, concatenated url and id,
* or just url.toString() if id is empty or null.
*/
private String globalSnippetId( URL url, String id )
{
if ( StringUtils.isEmpty( id ) )
{
return url.toString();
}
return url + " " + id;
}
/**
* Puts the given snippet into the cache.
*
* @param url The URL to parse.
* @param id The id of the snippet.
* @param content The content of the snippet.
*/
public void cacheSnippet( URL url, String id, String content )
{
cache.put( globalSnippetId( url, id ), content );
timeCached.put( globalSnippetId( url, id ), new Long( System.currentTimeMillis() ) );
}
/**
* Set the cache timeout.
*
* @param time The timeout to set.
*/
public void setCacheTimeout( int time )
{
this.timeout = time;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/AbstractMacro.java 0000644 0001750 0001750 00000006437 11202276630 030171 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Iterator;
import java.util.Map;
import org.apache.maven.doxia.logging.Log;
import org.apache.maven.doxia.logging.SystemStreamLog;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.codehaus.plexus.util.StringUtils;
/**
* Abstract base class to execute Macro.
*
* @author Jason van Zyl
* @version $Id: AbstractMacro.java 773896 2009-05-12 13:46:00Z ltheussl $
* @since 1.0
*/
public abstract class AbstractMacro
implements Macro
{
/** Log instance. */
private Log logger;
/** {@inheritDoc} */
public void enableLogging( Log log )
{
this.logger = log;
}
/**
* Returns a logger for this macro.
* If no logger has been configured, a new SystemStreamLog is returned.
*
* @return Log
* @since 1.1
*/
protected Log getLog()
{
if ( logger == null )
{
logger = new SystemStreamLog();
}
return logger;
}
/**
* Check if the given parameter is required. Throws an
* IllegalArgumentException if paramValue is null or empty.
*
* @param paramName The name of the parameter to check.
* @param paramValue The parameter value.
* @since 1.1
*/
protected void required( String paramName, String paramValue )
{
if ( StringUtils.isEmpty( paramValue ) )
{
throw new IllegalArgumentException( paramName + " is a required parameter!" );
}
}
/**
* Convert the Map of macro parameters to an AttributeSet.
* No check of validity is done, all parameters are added.
*
* @param parameters the macro parameters.
* @return a SinkEventAttributeSet containing the same parameters,
* or null if parameters is null.
*
* @since 1.1.1.
*/
protected static SinkEventAttributes getAttributesFromMap( Map parameters )
{
if ( parameters == null )
{
return null;
}
final int count = parameters.size();
if ( count <= 0 )
{
return null;
}
final SinkEventAttributeSet atts = new SinkEventAttributeSet( count );
for ( Iterator it = parameters.keySet().iterator(); it.hasNext(); )
{
final Object key = it.next();
atts.addAttribute( key, parameters.get( key ) );
}
return atts;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/ 0000755 0001750 0001750 00000000000 11632765553 026217 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroManager.java 0000644 0001750 0001750 00000003063 11150512221 031371 0 ustar twerner twerner package org.apache.maven.doxia.macro.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.macro.Macro;
/**
* Handles MacroManager lookups.
*
* @author Jason van Zyl
* @version $Id: MacroManager.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public interface MacroManager
{
/** The Plexus lookup role. */
String ROLE = MacroManager.class.getName();
/**
* Returns the MacroManager that corresponds to the given id.
*
* @param id The identifier.
* @return The corresponding MacroManager.
* @throws org.apache.maven.doxia.macro.manager.MacroNotFoundException if no MacroManager could be found
* for the given id.
*/
Macro getMacro( String id )
throws MacroNotFoundException;
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/DefaultMacroManager.java 0000644 0001750 0001750 00000003162 10661635336 032721 0 ustar twerner twerner package org.apache.maven.doxia.macro.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.macro.Macro;
import java.util.Map;
/**
* Default implementation of MacroManager
*
* @author Jason van Zyl
* @version $Id: DefaultMacroManager.java 567311 2007-08-18 18:30:54Z vsiveton $
* @since 1.0
* @plexus.component
*/
public class DefaultMacroManager
implements MacroManager
{
/** @plexus.requirement role="org.apache.maven.doxia.macro.Macro" */
private Map macros;
/** {@inheritDoc} */
public Macro getMacro( String id )
throws MacroNotFoundException
{
Macro macro = (Macro) macros.get( id );
if ( macro == null )
{
throw new MacroNotFoundException( "Cannot find macro with id = " + id );
}
return macro;
}
}
././@LongLink 0000000 0000000 0000000 00000000146 00000000000 011566 L ustar root root doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.java doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/manager/MacroNotFoundException.jav0000644 0001750 0001750 00000005033 11021234043 033270 0 ustar twerner twerner package org.apache.maven.doxia.macro.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Encapsulate an exception that indicates that a Macro
* does not exist or could not be found.
*
* @author Jason van Zyl
* @version $Id: MacroNotFoundException.java 662767 2008-06-03 12:25:07Z ltheussl $
* @since 1.0
*/
public class MacroNotFoundException
extends Exception
{
/** serialVersionUID */
static final long serialVersionUID = 295967936746221567L;
/**
* Construct a new MacroNotFoundException with the specified detail message.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
*/
public MacroNotFoundException( String message )
{
super( message );
}
/**
* Constructs a new MacroNotFoundException with the specified cause.
* The error message is (cause == null ? null : cause.toString() ).
*
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public MacroNotFoundException( Throwable cause )
{
super( cause );
}
/**
* Construct a new MacroNotFoundException with the specified
* detail message and cause.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public MacroNotFoundException( String message, Throwable cause )
{
super( message, cause );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/ 0000755 0001750 0001750 00000000000 11632765553 025372 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/toc/TocMacro.java 0000644 0001750 0001750 00000016054 11202340703 027725 0 ustar twerner twerner package org.apache.maven.doxia.macro.toc;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.StringReader;
import java.util.Iterator;
import org.apache.maven.doxia.index.IndexEntry;
import org.apache.maven.doxia.index.IndexingSink;
import org.apache.maven.doxia.macro.AbstractMacro;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.util.HtmlTools;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
/**
* Macro to display a Table Of Content in a given Sink.
* The input parameters for this macro are:
*
*
section
*
Display a TOC for the specified section only, or all sections if 0.
* Positive int, not mandatory, 0 by default.
*
fromDepth
*
Minimal depth of entries to display in the TOC.
* Sections are depth 1, sub-sections depth 2, etc.
* Positive int, not mandatory, 0 by default.
*
toDepth
*
Maximum depth of entries to display in the TOC.
* Positive int, not mandatory, 5 by default.
*
* For instance, in an APT file, you could write:
*
*
%{toc|section=2|fromDepth=2|toDepth=3}
*
Display a TOC for the second section in the document, including all
* subsections (depth 2) and sub-subsections (depth 3).
*
%{toc}
*
display a TOC with all section and subsections
* (similar to %{toc|section=0} )
*
* Moreover, you need to write APT link for section to allow anchor,
* for instance:
*
* * {SubSection 1}
*
*
* Similarly, in an XDOC file, you could write:
*
*
* @plexus.component role-hint="toc"
*
* @author Vincent Siveton
* @version $Id: TocMacro.java 774013 2009-05-12 18:36:51Z ltheussl $
*/
public class TocMacro
extends AbstractMacro
{
/** The section to display. */
private int section;
/** Start depth. */
private int fromDepth;
/** End depth. */
private int toDepth;
/** The default end depth. */
private static final int DEFAULT_DEPTH = 5;
/** {@inheritDoc} */
public void execute( Sink sink, MacroRequest request )
throws MacroExecutionException
{
String source = (String) request.getParameter( "sourceContent" );
Parser parser = (Parser) request.getParameter( "parser" );
section = getInt( request, "section", 0 );
fromDepth = getInt( request, "fromDepth", 0 );
toDepth = getInt( request, "toDepth", DEFAULT_DEPTH );
if ( fromDepth > toDepth )
{
return;
}
IndexEntry index = new IndexEntry( "index" );
IndexingSink tocSink = new IndexingSink( index );
try
{
parser.parse( new StringReader( source ), tocSink );
}
catch ( ParseException e )
{
throw new MacroExecutionException( "ParseException: " + e.getMessage(), e );
}
if ( index.getChildEntries().size() > 0 )
{
sink.list( getAttributesFromMap( request.getParameters() ) );
int i = 1;
for ( Iterator it = index.getChildEntries().iterator(); it.hasNext(); )
{
IndexEntry sectionIndex = (IndexEntry) it.next();
if ( ( i == section ) || ( section == 0 ) )
{
writeSubSectionN( sink, sectionIndex, 1 );
}
i++;
}
sink.list_();
}
}
/**
* @param sink The sink to write to.
* @param sectionIndex The section index.
* @param n The toc depth.
*/
private void writeSubSectionN( Sink sink, IndexEntry sectionIndex, int n )
{
if ( fromDepth <= n )
{
sink.listItem();
sink.link( "#" + HtmlTools.encodeId( sectionIndex.getId() ) );
sink.text( sectionIndex.getTitle() );
sink.link_();
}
if ( toDepth > n )
{
if ( sectionIndex.getChildEntries().size() > 0 )
{
if ( fromDepth <= n )
{
sink.list();
}
for ( Iterator it = sectionIndex.getChildEntries().iterator(); it.hasNext(); )
{
IndexEntry subsectionIndex = (IndexEntry) it.next();
if ( n == toDepth - 1 )
{
sink.listItem();
sink.link( "#" + HtmlTools.encodeId( subsectionIndex.getId() ) );
sink.text( subsectionIndex.getTitle() );
sink.link_();
sink.listItem_();
}
else
{
writeSubSectionN( sink, subsectionIndex, n + 1 );
}
}
if ( fromDepth <= n )
{
sink.list_();
}
}
}
if ( fromDepth <= n )
{
sink.listItem_();
}
}
/**
* @param request The MacroRequest.
* @param parameter The parameter.
* @param defaultValue the default value.
* @return the int value of a parameter in the request.
* @throws MacroExecutionException if something goes wrong.
*/
private static int getInt( MacroRequest request, String parameter, int defaultValue )
throws MacroExecutionException
{
String value = (String) request.getParameter( parameter );
if ( StringUtils.isEmpty( value ) )
{
return defaultValue;
}
int i;
try
{
i = Integer.parseInt( value );
}
catch ( NumberFormatException e )
{
return defaultValue;
}
if ( i < 0 )
{
throw new MacroExecutionException( "The " + parameter + "=" + i + " should be positive." );
}
return i;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/Macro.java 0000644 0001750 0001750 00000003360 11150512221 026464 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.logging.LogEnabled;
import org.apache.maven.doxia.sink.Sink;
/**
* Base interface of a macro.
*
* @author Jason van Zyl
* @version $Id: Macro.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public interface Macro
extends LogEnabled
{
/** The Plexus lookup role. */
String ROLE = Macro.class.getName();
/** The vm line separator */
String EOL = System.getProperty( "line.separator" );
/**
* Execute the current macro using the given MacroRequest,
* and emit events into the given sink.
*
* @param sink The sink to receive the events.
* @param request The corresponding MacroRequest.
* @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution.
*/
void execute( Sink sink, MacroRequest request )
throws MacroExecutionException;
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/SwfMacro.java 0000644 0001750 0001750 00000015534 11163505130 027157 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Iterator;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.util.StringUtils;
/**
* Macro for embedding Flash (SWF) within Maven documentation.
*
* @plexus.component role="org.apache.maven.doxia.macro.Macro"
* role-hint="swf"
*
* @author Steve Motola
* @author Vincent Siveton
* @version $Id: SwfMacro.java 759580 2009-03-28 20:36:40Z ltheussl $
*/
public class SwfMacro
extends AbstractMacro
{
/** {@inheritDoc} */
public void execute( Sink sink, MacroRequest request )
throws MacroExecutionException
{
// parameter defaults
String src = "";
String id = "swf";
String width = "400";
String height = "400";
String quality = "high";
String menu = "false";
String loop = "0";
String play = "true";
String version = "9,0,45,0";
String allowScript = "sameDomain";
// assign parameters
for ( Iterator i = request.getParameters().keySet().iterator(); i.hasNext(); )
{
String str = "";
String key = (String) i.next();
if ( key.equals( "src" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
src = str;
}
}
if ( key.equals( "id" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
id = str;
}
}
if ( key.equals( "width" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
width = str;
}
}
if ( key.equals( "height" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
height = str;
}
}
if ( key.equals( "quality" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
quality = str;
}
}
if ( key.equals( "menu" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
menu = str;
}
}
if ( key.equals( "loop" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
loop = str;
}
}
if ( key.equals( "play" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
play = str;
}
}
if ( key.equals( "version" ) )
{
str = (String) request.getParameter( key );
// enable version shorthand
// TODO: put in other shorthand versions
if ( str.equals( "6" ) )
{
version = "6,0,29,0";
}
else
{
if ( str.equals( "9" ) )
{
version = "9,0,45,0";
}
else
{
if ( StringUtils.isNotEmpty( str ) )
{
version = str;
}
}
}
}
if ( key.equals( "allowScript" ) )
{
str = (String) request.getParameter( key );
if ( StringUtils.isNotEmpty( str ) )
{
allowScript = str;
}
}
}
StringBuffer content = new StringBuffer();
content.append( "
" ).append( EOL );
sink.rawText( content.toString() );
}
} doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroRequest.java 0000644 0001750 0001750 00000004406 11150512221 030037 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Map;
import java.io.File;
/**
*
MacroRequest class.
*
* @author Jason van Zyl
* @version $Id: MacroRequest.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public class MacroRequest
{
/** The current base directory. */
private File basedir;
/** A map of parameters. */
private Map parameters;
/**
* Constructor.
*
* @param param A map of parameters.
* @param base The current base directory.
*/
public MacroRequest( Map param, File base )
{
this.parameters = param;
this.basedir = base;
}
/**
* Returns the current base directory.
*
* @return The base dir.
*/
public File getBasedir()
{
return basedir;
}
/**
* Sets the current base directory.
*
* @param base The current base directory.
*/
public void setBasedir( File base )
{
this.basedir = base;
}
/**
* Returns the map of parameters.
*
* @return The map of parameters.
*/
public Map getParameters()
{
return parameters;
}
/**
* Returns on object from the map of parameters
* that corresponds to the given key.
*
* @param key The key to lookup the object.
* @return The value object.
*/
public Object getParameter( String key )
{
return parameters.get( key );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/MacroExecutionException.java 0000644 0001750 0001750 00000004177 10765750233 032260 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Wrap an exception that occurs during the execution of a Doxia macro.
*
* @author Brett Porter
* @version $Id: MacroExecutionException.java 636300 2008-03-12 12:46:19Z vsiveton $
* @since 1.0
*/
public class MacroExecutionException
extends Exception
{
/** serialVersionUID */
static final long serialVersionUID = -6314856898570018814L;
/**
* Construct a new MacroExecutionException with the specified detail message.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
*/
public MacroExecutionException( String message )
{
super( message );
}
/**
* Construct a new MacroExecutionException with the specified
* detail message and cause.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public MacroExecutionException( String message, Throwable cause )
{
super( message, cause );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/macro/EchoMacro.java 0000644 0001750 0001750 00000003516 11150512221 027266 0 ustar twerner twerner package org.apache.maven.doxia.macro;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import java.util.Iterator;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* A simple macro that prints out the key and value of some supplied parameters.
*
* @plexus.component role-hint="echo"
* @version $Id: EchoMacro.java 746978 2009-02-23 12:20:33Z vsiveton $
*/
public class EchoMacro
extends AbstractMacro
{
/** {@inheritDoc} */
public void execute( Sink sink, MacroRequest request )
{
sink.verbatim( SinkEventAttributeSet.BOXED );
sink.text( "echo" + EOL );
for ( Iterator i = request.getParameters().keySet().iterator(); i.hasNext(); )
{
String key = (String) i.next();
// TODO: DOXIA-242: separate or define internal params
if ( "parser".equals( key ) || "sourceContent".equals( key ) )
{
continue;
}
sink.text( key + " ---> " + request.getParameter( key ) + EOL );
}
sink.verbatim_();
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/ 0000755 0001750 0001750 00000000000 11632765554 024462 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/LineBreaker.java 0000644 0001750 0001750 00000012662 11150512221 027467 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.codehaus.plexus.util.IOUtil;
import java.io.BufferedWriter;
import java.io.IOException;
import java.io.Writer;
/**
* Allows to specify the line-length of an output writer.
*
* @version $Id: LineBreaker.java 746978 2009-02-23 12:20:33Z vsiveton $
*/
public class LineBreaker
{
/** The default maximal line length. */
public static final int DEFAULT_MAX_LINE_LENGTH = 78;
/** The system dependent EOL. */
private static final String EOL = System.getProperty( "line.separator" );
/** The destination writer. */
private Writer destination;
/** The writer to use. */
private BufferedWriter writer;
/** The maximal line length. */
private int maxLineLength;
/** The current line length. */
private int lineLength = 0;
/** The string buffer to store the current text. */
private StringBuffer word = new StringBuffer( 1024 );
/**
* Constructs a new LineBreaker with DEFAULT_MAX_LINE_LENGTH.
*
* @param out The writer to use.
*/
public LineBreaker( Writer out )
{
this( out, DEFAULT_MAX_LINE_LENGTH );
}
/**
* Constructs a new LineBreaker with the given max line length.
*
* @param out The writer to use.
* @param max The maximal line length.
*/
public LineBreaker( Writer out, int max )
{
if ( max <= 0 )
{
throw new IllegalArgumentException( "maxLineLength <= 0" );
}
destination = out;
this.maxLineLength = max;
writer = new BufferedWriter( out );
}
/**
* Returns the current destination writer.
*
* @return The destination.
*/
public Writer getDestination()
{
return destination;
}
/**
* Writes the given text to the writer. White space is not preserved.
*
* @param text The text to write.
* @throws java.io.IOException if there's a problem writing the text.
*/
public void write( String text )
throws IOException
{
write( text, /*preserveSpace*/false );
}
/**
* Writes the given text to the writer.
*
* @param text The text to write.
* @param preserveSpace True to preserve white space.
*/
public void write( String text, boolean preserveSpace )
{
int length = text.length();
try
{
for ( int i = 0; i < length; ++i )
{
char c = text.charAt( i );
switch ( c )
{
case ' ':
if ( preserveSpace )
{
word.append( c );
}
else
{
writeWord();
}
break;
case '\r':
// if \r\n (windows) then just pass along \n
if ( i + 1 < length && text.charAt( i + 1 ) == '\n' )
{
break;
}
case '\n':
writeWord();
writer.write( EOL );
lineLength = 0;
break;
default:
word.append( c );
}
}
}
catch ( Exception e )
{
// TODO: log
}
}
/**
* Write out the current StringBuffer and flush the writer.
* Any IOException will be swallowed.
*/
public void flush()
{
try
{
writeWord();
writer.flush();
}
catch ( IOException e )
{
// TODO: log
}
}
/**
* Writes the current StringBuffer to the writer.
*
* @throws IOException if an exception occurs during writing.
*/
private void writeWord()
throws IOException
{
int length = word.length();
if ( length > 0 )
{
if ( lineLength > 0 )
{
if ( lineLength + 1 + length > maxLineLength )
{
writer.write( EOL );
lineLength = 0;
}
else
{
writer.write( ' ' );
++lineLength;
}
}
writer.write( word.toString() );
word.setLength( 0 );
lineLength += length;
}
}
/**
* Close the writer.
*/
public void close()
{
IOUtil.close( writer );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineReaderSource.java 0000644 0001750 0001750 00000006736 11203262772 031013 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/*
* Originally from org.apache.doxia.module.apt.AptReaderSource. It was modified
* to get unget support
*/
import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import org.apache.maven.doxia.parser.ParseException;
import org.codehaus.plexus.util.IOUtil;
/**
* {@link ByLineSource} default implementation
*
* @version $Id: ByLineReaderSource.java 775115 2009-05-15 12:54:18Z ltheussl $
*/
public class ByLineReaderSource implements ByLineSource
{
/**
* reader
*/
private LineNumberReader reader;
/**
* current line number
*/
private int lineNumber;
/**
* holds the last line returned by getNextLine()
*/
private String lastLine;
/**
* true if ungetLine() was called and no getNextLine() was
* called
*/
private boolean ungetted = false;
/**
* Creates the ByLineReaderSource.
*
* @param in real source :)
*/
public ByLineReaderSource( final Reader in )
{
reader = new LineNumberReader( in );
lineNumber = -1;
}
/** {@inheritDoc} */
public final String getNextLine() throws ParseException
{
if ( reader == null )
{
return null;
}
if ( ungetted )
{
ungetted = false;
return lastLine;
}
String line;
try
{
line = reader.readLine();
if ( line == null )
{
reader.close();
reader = null;
}
else
{
lineNumber = reader.getLineNumber();
}
}
catch ( IOException e )
{
throw new ParseException( e, lineNumber, 0 );
}
lastLine = line;
return line;
}
/** {@inheritDoc} */
public final String getName()
{
return "";
}
/** {@inheritDoc} */
public final int getLineNumber()
{
return lineNumber;
}
/** {@inheritDoc} */
public final void close()
{
IOUtil.close( reader );
reader = null;
}
/** {@inheritDoc} */
public final void ungetLine()
{
if ( ungetted )
{
throw new IllegalStateException( "we support only one level of ungetLine()" );
}
ungetted = true;
}
/** {@inheritDoc} */
public final void unget( final String s )
{
if ( s == null )
{
throw new IllegalArgumentException( "argument can't be null" );
}
if ( s.length() != 0 )
{
ungetLine();
lastLine = s;
}
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/XmlValidator.java 0000644 0001750 0001750 00000020230 11372510716 027715 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.IOException;
import java.io.StringReader;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.xml.XMLConstants;
import org.apache.maven.doxia.logging.Log;
import org.apache.maven.doxia.markup.XmlMarkup;
import org.apache.maven.doxia.parser.AbstractXmlParser.CachedFileEntityResolver;
import org.apache.maven.doxia.parser.ParseException;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.SAXParseException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.DefaultHandler;
import org.xml.sax.helpers.XMLReaderFactory;
/**
* A class to validate xml documents.
*
* @version $Id$
* @since 1.1.3
*/
public class XmlValidator
{
/**
* Doctype pattern i.e. ".*]*)>.*"
* see http://www.w3.org/TR/REC-xml/#NT-doctypedecl.
*/
private static final Pattern PATTERN_DOCTYPE = Pattern.compile( ".*" + XmlMarkup.DOCTYPE_START + "([^>]*)>.*" );
/** Tag pattern as defined in http://www.w3.org/TR/REC-xml/#NT-Name */
private static final Pattern PATTERN_TAG = Pattern.compile( ".*<([A-Za-z][A-Za-z0-9:_.-]*)([^>]*)>.*" );
/** lazy xmlReader to validate xml content*/
private XMLReader xmlReader;
private Log logger;
/**
* Constructor.
*
* @param log a logger, not null.
*/
public XmlValidator( Log log )
{
this.logger = log;
}
/**
* Validate an XML content with SAX.
*
* @param content a not null xml content
* @throws ParseException if any.
*/
public void validate( String content )
throws ParseException
{
try
{
// 1 if there's a doctype
boolean hasDoctype = false;
Matcher matcher = PATTERN_DOCTYPE.matcher( content );
if ( matcher.find() )
{
hasDoctype = true;
}
// 2 check for an xmlns instance
boolean hasXsd = false;
matcher = PATTERN_TAG.matcher( content );
if ( matcher.find() )
{
String value = matcher.group( 2 );
if ( value.indexOf( XMLConstants.W3C_XML_SCHEMA_INSTANCE_NS_URI ) != -1 )
{
hasXsd = true;
}
}
// 3 validate content
getLog().debug( "Validating the content..." );
getXmlReader( hasXsd && hasDoctype ).parse( new InputSource( new StringReader( content ) ) );
}
catch ( IOException e )
{
throw new ParseException( "Error validating the model: " + e.getMessage(), e );
}
catch ( SAXException e )
{
throw new ParseException( "Error validating the model: " + e.getMessage(), e );
}
}
/**
* @param hasDtdAndXsd to flag the ErrorHandler.
* @return an xmlReader instance.
* @throws SAXException if any
*/
private XMLReader getXmlReader( boolean hasDtdAndXsd )
throws SAXException
{
if ( xmlReader == null )
{
MessagesErrorHandler errorHandler = new MessagesErrorHandler( getLog() );
xmlReader = XMLReaderFactory.createXMLReader( "org.apache.xerces.parsers.SAXParser" );
xmlReader.setFeature( "http://xml.org/sax/features/validation", true );
xmlReader.setFeature( "http://apache.org/xml/features/validation/schema", true );
xmlReader.setErrorHandler( errorHandler );
xmlReader.setEntityResolver( new CachedFileEntityResolver() );
}
( (MessagesErrorHandler) xmlReader.getErrorHandler() ).setHasDtdAndXsd( hasDtdAndXsd );
return xmlReader;
}
private Log getLog()
{
return logger;
}
/**
* Convenience class to beautify SAXParseException messages.
*/
static class MessagesErrorHandler
extends DefaultHandler
{
private static final int TYPE_UNKNOWN = 0;
private static final int TYPE_WARNING = 1;
private static final int TYPE_ERROR = 2;
private static final int TYPE_FATAL = 3;
private static final String EOL = XmlMarkup.EOL;
/** @see org/apache/xerces/impl/msg/XMLMessages.properties#MSG_ELEMENT_NOT_DECLARED */
private static final Pattern ELEMENT_TYPE_PATTERN =
Pattern.compile( "Element type \".*\" must be declared.", Pattern.DOTALL );
private final Log log;
private boolean hasDtdAndXsd;
public MessagesErrorHandler( Log log )
{
this.log = log;
}
/**
* @param hasDtdAndXsd the hasDtdAndXsd to set
*/
protected void setHasDtdAndXsd( boolean hasDtdAndXsd )
{
this.hasDtdAndXsd = hasDtdAndXsd;
}
/** {@inheritDoc} */
public void warning( SAXParseException e )
throws SAXException
{
processException( TYPE_WARNING, e );
}
/** {@inheritDoc} */
public void error( SAXParseException e )
throws SAXException
{
// Workaround for Xerces complaints when an XML with XSD needs also a to specify entities
// like
// See http://xsd.stylusstudio.com/2001Nov/post08021.htm
if ( !hasDtdAndXsd )
{
processException( TYPE_ERROR, e );
return;
}
Matcher m = ELEMENT_TYPE_PATTERN.matcher( e.getMessage() );
if ( !m.find() )
{
processException( TYPE_ERROR, e );
}
}
/** {@inheritDoc} */
public void fatalError( SAXParseException e )
throws SAXException
{
processException( TYPE_FATAL, e );
}
private void processException( int type, SAXParseException e )
throws SAXException
{
StringBuffer message = new StringBuffer();
switch ( type )
{
case TYPE_WARNING:
message.append( "Warning:" );
break;
case TYPE_ERROR:
message.append( "Error:" );
break;
case TYPE_FATAL:
message.append( "Fatal error:" );
break;
case TYPE_UNKNOWN:
default:
message.append( "Unknown:" );
break;
}
message.append( EOL );
message.append( " Public ID: " + e.getPublicId() ).append( EOL );
message.append( " System ID: " + e.getSystemId() ).append( EOL );
message.append( " Line number: " + e.getLineNumber() ).append( EOL );
message.append( " Column number: " + e.getColumnNumber() ).append( EOL );
message.append( " Message: " + e.getMessage() ).append( EOL );
final String logMessage = message.toString();
switch ( type )
{
case TYPE_WARNING:
log.warn( logMessage );
break;
case TYPE_UNKNOWN:
case TYPE_ERROR:
case TYPE_FATAL:
default:
throw new SAXException( logMessage );
}
}
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/ByLineSource.java 0000644 0001750 0001750 00000004203 11216135717 027655 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.ParseException;
/**
* The token are the new lines :)
*
* @author Juan F. Codagnone
* @since Nov 4, 2005
* @version $Id: ByLineSource.java 785531 2009-06-17 09:47:59Z ltheussl $
*/
public interface ByLineSource
{
/**
*
getNextLine.
*
* @return the next line. null if we reached the end.
* @throws org.apache.maven.doxia.parser.ParseException on I/O error
*/
String getNextLine() throws ParseException;
/**
*
getName.
*
* @return the name of the input. could be the filename for example.
*/
String getName();
/**
*
getLineNumber.
*
* @return the current line number.
*/
int getLineNumber();
/**
*
ungetLine.
*
* This should throw a java.lang.IllegalStateException if called more than
* one time without calling getNextLine().
*/
void ungetLine();
/**
*
unget.
*
* @param s some text to push back to the parser.
* This should throw a java.lang.IllegalStateException if called more than
* one time without calling getNextLine().
*/
void unget( String s );
/**
* close the source.
*/
void close();
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/DoxiaUtils.java 0000644 0001750 0001750 00000031774 11213220542 027400 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.awt.image.BufferedImage;
import java.io.File;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URL;
import java.text.ParseException;
import java.text.ParsePosition;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.Locale;
import javax.imageio.ImageIO;
import javax.swing.text.MutableAttributeSet;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
/**
* General Doxia utility methods. The methods in this class should not assume
* any specific Doxia module or document format.
*
* @author ltheussl
* @since 1.1
* @version $Id: DoxiaUtils.java 782648 2009-06-08 14:34:10Z ltheussl $
*/
public class DoxiaUtils
{
private static final int MINUS_ONE = 0xFF;
/**
* Checks if the given string corresponds to an internal link,
* ie it is a link to an anchor within the same document.
*
* @param link The link to check.
* @return True if the link starts with "#".
*
* @see #isExternalLink(String)
* @see #isLocalLink(String)
*/
public static boolean isInternalLink( String link )
{
return link.startsWith( "#" );
}
/**
* Checks if the given string corresponds to an external URI,
* ie is not a link within the same document nor a relative link
* to another document (a local link) of the same site.
*
* @param link The link to check.
* @return True if the link (ignoring case) starts with either "http:/",
* "https:/", "ftp:/", "mailto:", "file:/", or contains the string "://".
* Note that Windows style separators "\" are not allowed
* for URIs, see http://www.ietf.org/rfc/rfc2396.txt , section 2.4.3.
*
* @see #isInternalLink(String)
* @see #isLocalLink(String)
*/
public static boolean isExternalLink( String link )
{
String text = link.toLowerCase( Locale.ENGLISH );
return ( text.startsWith( "http:/" ) || text.startsWith( "https:/" )
|| text.startsWith( "ftp:/" ) || text.startsWith( "mailto:" )
|| text.startsWith( "file:/" ) || text.indexOf( "://" ) != -1 );
}
/**
* Checks if the given string corresponds to a relative link to another document
* within the same site, ie it is neither an {@link #isInternalLink(String) internal}
* nor an {@link #isExternalLink(String) external} link.
*
* @param link The link to check.
* @return True if the link is neither an external nor an internal link.
*
* @see #isExternalLink(String)
* @see #isInternalLink(String)
*/
public static boolean isLocalLink( String link )
{
return ( !isExternalLink( link ) && !isInternalLink( link ) );
}
/**
* Construct a valid Doxia id.
*
*
* This method is equivalent to {@link #encodeId(java.lang.String, boolean) encodeId( id, false )}.
*
*
* @param id The id to be encoded.
* @return The trimmed and encoded id, or null if id is null.
* @see #encodeId(java.lang.String, boolean)
*/
public static String encodeId( String id )
{
return encodeId( id, false );
}
/**
* Construct a valid Doxia id.
*
*
* ID and NAME tokens must begin with a letter ([A-Za-z]) and may be
* followed by any number of letters, digits ([0-9]), hyphens ("-"),
* underscores ("_"), colons (":"), and periods (".").
*
*
* @param id The id to be encoded.
* @param chop true if non-ASCII characters should be ignored.
* If false, any non-ASCII characters will be replaced as specified above.
* @return The trimmed and encoded id, or null if id is null.
* If id is not null, the return value is guaranteed to be a valid Doxia id.
*
* @since 1.1.1
*/
public static String encodeId( String id, boolean chop )
{
if ( id == null )
{
return null;
}
id = id.trim();
int length = id.length();
if ( length == 0 )
{
return "a";
}
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = id.charAt( i );
if ( ( i == 0 ) && ( !isAsciiLetter( c ) ) )
{
buffer.append( 'a' );
}
if ( c == ' ' )
{
buffer.append( '_' );
}
else if ( isAsciiLetter( c ) || isAsciiDigit( c ) || ( c == '-' ) || ( c == '_' ) || ( c == ':' )
|| ( c == '.' ) )
{
buffer.append( c );
}
else if ( !chop )
{
byte[] bytes;
try
{
bytes = String.valueOf( c ).getBytes( "UTF8" );
}
catch ( UnsupportedEncodingException cannotHappen )
{
bytes = new byte[0];
}
for ( int j = 0; j < bytes.length; ++j )
{
String hex = byteToHex( bytes[j] );
buffer.append( '%' );
if ( hex.length() == 1 )
{
buffer.append( '0' );
}
buffer.append( hex );
}
}
}
return buffer.toString();
}
/**
* Convert a byte to it's hexadecimal equivalent.
*
* @param b the byte value.
* @return the result of Integer.toHexString( b & 0xFF ).
*
* @since 1.1.1
*/
public static String byteToHex( byte b )
{
return Integer.toHexString( b & MINUS_ONE );
}
/**
* Determines if the specified text is a valid id according to the rules
* laid out in {@link #encodeId(String)}.
*
* @param text The text to be tested.
* @return true if the text is a valid id, otherwise false.
* @see #encodeId(String)
*/
public static boolean isValidId( String text )
{
if ( text == null || text.length() == 0 )
{
return false;
}
for ( int i = 0; i < text.length(); ++i )
{
char c = text.charAt( i );
if ( isAsciiLetter( c ) )
{
continue;
}
if ( ( i == 0 ) || ( c == ' ' ) || ( !isAsciiDigit( c ) && c != '-' && c != '_' && c != ':' && c != '.' ) )
{
return false;
}
}
return true;
}
private static final SimpleDateFormat DATE_PARSER = new SimpleDateFormat( "", Locale.ENGLISH );
private static final ParsePosition DATE_PARSE_POSITION = new ParsePosition( 0 );
private static final String[] DATE_PATTERNS = new String[]
{
"yyyy-MM-dd", "yyyy/MM/dd", "yyyyMMdd", "yyyy", "dd.MM.yyyy", "dd MMM yyyy",
"dd MMM. yyyy", "MMMM yyyy", "MMM. dd, yyyy", "MMM. yyyy", "MMMM dd, yyyy",
"MMM d, ''yy", "MMM. ''yy", "MMMM ''yy"
};
/**
*
Parses a string representing a date by trying different date patterns.
*
*
The following date patterns are tried (in the given order):
A parse is only sucessful if it parses the whole of the input string.
* If no parse patterns match, a ParseException is thrown.
*
*
As a special case, the strings "today" and "now"
* (ignoring case) return the current date.
*
* @param str the date to parse, not null.
* @return the parsed date, or the current date if the input String (ignoring case) was
* "today" or "now".
* @throws ParseException if no pattern matches.
*
* @since 1.1.1.
*/
public static Date parseDate( String str )
throws ParseException
{
if ( "today".equals( str.toLowerCase( Locale.ENGLISH ) )
|| "now".equals( str.toLowerCase( Locale.ENGLISH ) ) )
{
return new Date();
}
for ( int i = 0; i < DATE_PATTERNS.length; i++ )
{
DATE_PARSER.applyPattern( DATE_PATTERNS[i] );
DATE_PARSE_POSITION.setIndex( 0 );
final Date date = DATE_PARSER.parse( str, DATE_PARSE_POSITION );
if ( date != null && DATE_PARSE_POSITION.getIndex() == str.length() )
{
return date;
}
}
throw new ParseException( "Unable to parse date: " + str, -1 );
}
//
// private
//
private static boolean isAsciiLetter( char c )
{
return ( ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) );
}
private static boolean isAsciiDigit( char c )
{
return ( c >= '0' && c <= '9' );
}
/**
* Determine width and height of an image. If successful, the returned SinkEventAttributes
* contain width and height attribute keys whose values are the width and height of the image (as a String).
*
* @param logo a String containing either a URL or a path to an image file.
* @return a set of SinkEventAttributes, or null if no ImageReader was found to read the image.
* @throws java.io.IOException if an error occurs during reading.
* @since 1.1.1
*/
public static MutableAttributeSet getImageAttributes( String logo )
throws IOException
{
BufferedImage img = null;
if ( isExternalLink( logo ) )
{
img = ImageIO.read( new URL( logo ) );
}
else
{
img = ImageIO.read( new File( logo ) );
}
if ( img == null )
{
return null;
}
MutableAttributeSet atts = new SinkEventAttributeSet();
atts.addAttribute( SinkEventAttributeSet.WIDTH, Integer.toString( img.getWidth() ) );
atts.addAttribute( SinkEventAttributeSet.HEIGHT, Integer.toString( img.getHeight() ) );
// add other attributes?
return atts;
}
private DoxiaUtils()
{
// utility class
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/util/HtmlTools.java 0000644 0001750 0001750 00000041230 11216135717 027240 0 ustar twerner twerner package org.apache.maven.doxia.util;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.UnsupportedEncodingException;
import java.util.ArrayList;
import java.util.Hashtable;
import java.util.List;
import javax.swing.text.html.HTML.Tag;
import org.apache.commons.lang.StringEscapeUtils;
import org.apache.maven.doxia.markup.HtmlMarkup;
import org.codehaus.plexus.util.StringUtils;
/**
* The HtmlTools class defines methods to HTML handling.
*
* @author Vincent Siveton
* @version $Id: HtmlTools.java 785531 2009-06-17 09:47:59Z ltheussl $
* @since 1.0
*/
public class HtmlTools
{
private static final Tag[] ALL_TAGS =
{
HtmlMarkup.A, HtmlMarkup.ABBR, HtmlMarkup.ACRONYM, HtmlMarkup.ADDRESS, HtmlMarkup.APPLET,
HtmlMarkup.AREA, HtmlMarkup.B, HtmlMarkup.BASE, HtmlMarkup.BASEFONT, HtmlMarkup.BDO,
HtmlMarkup.BIG, HtmlMarkup.BLOCKQUOTE, HtmlMarkup.BODY, HtmlMarkup.BR, HtmlMarkup.BUTTON,
HtmlMarkup.CAPTION, HtmlMarkup.CENTER, HtmlMarkup.CITE, HtmlMarkup.CODE, HtmlMarkup.COL,
HtmlMarkup.COLGROUP, HtmlMarkup.DD, HtmlMarkup.DEL, HtmlMarkup.DFN, HtmlMarkup.DIR,
HtmlMarkup.DIV, HtmlMarkup.DL, HtmlMarkup.DT, HtmlMarkup.EM, HtmlMarkup.FIELDSET,
HtmlMarkup.FONT, HtmlMarkup.FORM, HtmlMarkup.FRAME, HtmlMarkup.FRAMESET, HtmlMarkup.H1,
HtmlMarkup.H2, HtmlMarkup.H3, HtmlMarkup.H4, HtmlMarkup.H5, HtmlMarkup.H6, HtmlMarkup.HEAD,
HtmlMarkup.HR, HtmlMarkup.HTML, HtmlMarkup.I, HtmlMarkup.IFRAME, HtmlMarkup.IMG,
HtmlMarkup.INPUT, HtmlMarkup.INS, HtmlMarkup.ISINDEX, HtmlMarkup.KBD, HtmlMarkup.LABEL,
HtmlMarkup.LEGEND, HtmlMarkup.LI, HtmlMarkup.LINK, HtmlMarkup.MAP, HtmlMarkup.MENU,
HtmlMarkup.META, HtmlMarkup.NOFRAMES, HtmlMarkup.NOSCRIPT, HtmlMarkup.OBJECT, HtmlMarkup.OL,
HtmlMarkup.OPTGROUP, HtmlMarkup.OPTION, HtmlMarkup.P, HtmlMarkup.PARAM, HtmlMarkup.PRE,
HtmlMarkup.Q, HtmlMarkup.S, HtmlMarkup.SAMP, HtmlMarkup.SCRIPT, HtmlMarkup.SELECT,
HtmlMarkup.SMALL, HtmlMarkup.SPAN, HtmlMarkup.STRIKE, HtmlMarkup.STRONG, HtmlMarkup.STYLE,
HtmlMarkup.SUB, HtmlMarkup.SUP, HtmlMarkup.TABLE, HtmlMarkup.TBODY, HtmlMarkup.TD,
HtmlMarkup.TEXTAREA, HtmlMarkup.TFOOT, HtmlMarkup.TH, HtmlMarkup.THEAD, HtmlMarkup.TITLE,
HtmlMarkup.TR, HtmlMarkup.TT, HtmlMarkup.U, HtmlMarkup.UL, HtmlMarkup.VAR
};
private static final Hashtable TAG_HASHTABLE = new Hashtable( ALL_TAGS.length );
private static final int ASCII = 0x7E;
static
{
for ( int i = 0; i < ALL_TAGS.length; i++ )
{
TAG_HASHTABLE.put( ALL_TAGS[i].toString(), ALL_TAGS[i] );
}
}
/**
* Returns a tag for a defined HTML tag name. This is one of
* the tags defined in {@link org.apache.maven.doxia.markup.HtmlMarkup}.
* If the given name does not represent one of the defined tags, then
* null will be returned.
*
* @param tagName the String name requested.
* @return a tag constant corresponding to the tagName,
* or null if not found.
* @see http://www.w3.org/TR/html401/index/elements.html
* @since 1.1
*/
public static Tag getHtmlTag( String tagName )
{
Object t = TAG_HASHTABLE.get( tagName );
return ( t == null ? null : (Tag) t );
}
/**
* Escape special HTML characters in a String in xml mode.
*
* Note: this method doesn't escape non-ascii characters by numeric characters references.
*
* @param text the String to escape, may be null.
* @return The escaped text or the empty string if text == null.
* @see #escapeHTML(String,boolean)
*/
public static String escapeHTML( String text )
{
return escapeHTML( text, true );
}
/**
* Escape special HTML characters in a String.
*
*
*
* If xmlMode is true, every other character than the above remains unchanged,
* if xmlMode is false, non-ascii characters get replaced by their hex code.
*
* Note: all characters are encoded, i.e.:
*
* \u0159 = ř
* \uD835\uDFED = 𝟭
*
*
* @param text The String to escape, may be null.
* @param xmlMode true to replace also ' to &apos, false to replace non-ascii
* characters by numeric characters references.
* @return The escaped text or the empty string if text == null.
* @since 1.1
* @see http://www.w3.org/TR/2000/REC-xml-20001006#sec-predefined-ent
* @see http://www.w3.org/TR/html401/charset.html#h-5.3
*/
public static final String escapeHTML( String text, boolean xmlMode )
{
if ( text == null )
{
return "";
}
int length = text.length();
StringBuffer buffer = new StringBuffer( length );
for ( int i = 0; i < length; ++i )
{
char c = text.charAt( i );
switch ( c )
{
case '<':
buffer.append( "<" );
break;
case '>':
buffer.append( ">" );
break;
case '&':
buffer.append( "&" );
break;
case '\"':
buffer.append( """ );
break;
default:
if ( xmlMode )
{
if ( c == '\'' )
{
buffer.append( "'" );
}
else
{
buffer.append( c );
}
}
else
{
if ( c <= ASCII )
{
// ASCII.
buffer.append( c );
}
else
{
buffer.append( "&#x" );
if ( isHighSurrogate( c ) )
{
buffer.append( Integer.toHexString( toCodePoint( c, text.charAt( ++i ) ) ) );
}
else
{
buffer.append( Integer.toHexString( c ) );
}
buffer.append( ';' );
}
}
}
}
return buffer.toString();
}
/**
* Unescapes HTML entities in a string in non xml mode.
*
* @param text the String to unescape, may be null.
* @return a new unescaped String, null if null string input.
* @since 1.1.1.
* @see #unescapeHTML(String, boolean)
*/
public static String unescapeHTML( String text )
{
return unescapeHTML( text, false );
}
/**
* Unescapes HTML entities in a string.
*
*
Unescapes a string containing entity escapes to a string
* containing the actual Unicode characters corresponding to the
* escapes. Supports HTML 4.0 entities.
*
*
For example, the string "<Français>"
* will become "<Français>".
*
* Note: all unicode entities are decoded, i.e.:
*
* ř = \u0159
* 𝟭 = \uD835\uDFED
*
*
* @param text the String to unescape, may be null.
* @param xmlMode set to true to replace &apos by '.
* @return a new unescaped String, null if null string input.
* @since 1.1.1.
*/
public static String unescapeHTML( String text, boolean xmlMode )
{
if ( text == null )
{
return null;
}
String unescaped;
if ( xmlMode )
{
unescaped = StringEscapeUtils.unescapeXml( text );
}
else
{
// StringEscapeUtils.unescapeHtml returns entities it doesn't recognize unchanged
unescaped = StringEscapeUtils.unescapeHtml( text );
}
String tmp = unescaped;
List entities = new ArrayList();
while ( true )
{
int i = tmp.indexOf( "&#x" );
if ( i == -1 )
{
break;
}
tmp = tmp.substring( i + 3 );
if ( tmp.indexOf( ';' ) != -1 )
{
String entity = tmp.substring( 0, tmp.indexOf( ';' ) );
try
{
Integer.parseInt( entity, 16 );
entities.add( entity );
}
catch ( NumberFormatException e )
{
// nop
}
}
}
for ( int i = 0; i < entities.size(); i++ )
{
String entity = (String) entities.get( i );
int codePoint = Integer.parseInt( entity, 16 );
unescaped = StringUtils.replace( unescaped, "&#x" + entity + ";", new String( toChars( codePoint ) ) );
}
return unescaped;
}
/**
* Encode an url
*
* @param url the String to encode, may be null
* @return the text encoded, null if null String input
*/
public static String encodeURL( String url )
{
if ( url == null )
{
return null;
}
StringBuffer encoded = new StringBuffer();
int length = url.length();
char[] unicode = new char[1];
for ( int i = 0; i < length; ++i )
{
char c = url.charAt( i );
switch ( c )
{
case ';':
case '/':
case '?':
case ':':
case '@':
case '&':
case '=':
case '+':
case '$':
case ',':
case '[':
case ']': // RFC 2732 (IPV6)
case '-':
case '_':
case '.':
case '!':
case '~':
case '*':
case '\'':
case '(':
case ')':
case '#': // XLink mark
encoded.append( c );
break;
default:
if ( ( c >= 'a' && c <= 'z' ) || ( c >= 'A' && c <= 'Z' ) || ( c >= '0' && c <= '9' ) )
{
encoded.append( c );
}
else
{
byte[] bytes;
try
{
if ( isHighSurrogate( c ) )
{
int codePoint = toCodePoint( c, url.charAt( ++i ) );
unicode = toChars( codePoint );
bytes = ( new String( unicode, 0, unicode.length ) ).getBytes( "UTF8" );
}
else
{
unicode[0] = c;
bytes = ( new String( unicode, 0, 1 ) ).getBytes( "UTF8" );
}
}
catch ( UnsupportedEncodingException cannotHappen )
{
bytes = new byte[0];
}
for ( int j = 0; j < bytes.length; ++j )
{
String hex = DoxiaUtils.byteToHex( bytes[j] );
encoded.append( '%' );
if ( hex.length() == 1 )
{
encoded.append( '0' );
}
encoded.append( hex );
}
}
}
}
return encoded.toString();
}
/**
* Construct a valid id.
*
*
* Note: this method is identical to
* {@link DoxiaUtils#encodeId(String,boolean) DoxiaUtils.encodeId( id, true)},
* the rules to encode an id are laid out there.
*
*
* @param id The id to be encoded.
* @return The trimmed and encoded id, or null if id is null.
* @see DoxiaUtils#encodeId(java.lang.String,boolean)
*/
public static String encodeId( String id )
{
return DoxiaUtils.encodeId( id, true );
}
/**
* Determines if the specified text is a valid id according to the rules
* laid out in {@link #encodeId(String)}.
*
* @param text The text to be tested.
* @return true if the text is a valid id, otherwise false.
* @see #encodeId(String).
*/
public static boolean isId( String text )
{
return DoxiaUtils.isValidId( text );
}
private HtmlTools()
{
// utility class
}
//
// Imported code from ASF Harmony project rev 770909
// http://svn.apache.org/repos/asf/harmony/enhanced/classlib/trunk/modules/luni/src/main/java/java/lang/Character.java
//
private static final char LUNATE_SIGMA = 0x3FF;
private static final char NON_PRIVATE_USE_HIGH_SURROGATE = 0xD800;
private static final char LOW_SURROGATE = 0xDC00;
private static int toCodePoint( char high, char low )
{
// See RFC 2781, Section 2.2
// http://www.faqs.org/rfcs/rfc2781.html
int h = ( high & LUNATE_SIGMA ) << 10;
int l = low & LUNATE_SIGMA;
return ( h | l ) + MIN_SUPPLEMENTARY_CODE_POINT;
}
private static final char MIN_HIGH_SURROGATE = '\uD800';
private static final char MAX_HIGH_SURROGATE = '\uDBFF';
private static boolean isHighSurrogate( char ch )
{
return ( MIN_HIGH_SURROGATE <= ch && MAX_HIGH_SURROGATE >= ch );
}
private static final int MIN_CODE_POINT = 0x000000;
private static final int MAX_CODE_POINT = 0x10FFFF;
private static final int MIN_SUPPLEMENTARY_CODE_POINT = 0x10000;
private static boolean isValidCodePoint( int codePoint )
{
return ( MIN_CODE_POINT <= codePoint && MAX_CODE_POINT >= codePoint );
}
private static boolean isSupplementaryCodePoint( int codePoint )
{
return ( MIN_SUPPLEMENTARY_CODE_POINT <= codePoint && MAX_CODE_POINT >= codePoint );
}
/**
* Converts the given code point to an equivalent character array.
*
* @param codePoint the code point to convert.
* @return If codePoint is a supplementary code point, returns a character array of length 2,
* otherwise a character array of length 1 containing only the original int as a char.
*/
public static char[] toChars( int codePoint )
{
if ( !isValidCodePoint( codePoint ) )
{
throw new IllegalArgumentException();
}
if ( isSupplementaryCodePoint( codePoint ) )
{
int cpPrime = codePoint - MIN_SUPPLEMENTARY_CODE_POINT;
int high = NON_PRIVATE_USE_HIGH_SURROGATE | ( ( cpPrime >> 10 ) & LUNATE_SIGMA );
int low = LOW_SURROGATE | ( cpPrime & LUNATE_SIGMA );
return new char[] { (char) high, (char) low };
}
return new char[] { (char) codePoint };
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/ 0000755 0001750 0001750 00000000000 11632765553 024771 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/ 0000755 0001750 0001750 00000000000 11632765554 025736 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/ 0000755 0001750 0001750 00000000000 11632765554 027350 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000147 00000000000 011567 L ustar root root doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.java doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleManager.ja0000644 0001750 0001750 00000003407 11150512221 033205 0 ustar twerner twerner package org.apache.maven.doxia.module.site.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.module.site.SiteModule;
import java.util.Collection;
/**
* Handles SiteModule lookups.
*
* @author Jason van Zyl
* @version $Id: SiteModuleManager.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public interface SiteModuleManager
{
/** The Plexus lookup role. */
String ROLE = SiteModuleManager.class.getName();
/**
* Returns a collection of SiteModules.
*
* @return The SiteModules.
*/
Collection getSiteModules();
/**
* Returns the SiteModule that corresponds to the given id.
*
* @param id The identifier.
* @return The corresponding SiteModule.
* @throws org.apache.maven.doxia.module.site.manager.SiteModuleNotFoundException if no SiteModule could be found
* for the given id.
*/
SiteModule getSiteModule( String id )
throws SiteModuleNotFoundException;
}
././@LongLink 0000000 0000000 0000000 00000000156 00000000000 011567 L ustar root root doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/DefaultSiteModuleManager.java doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/DefaultSiteModuleMan0000644 0001750 0001750 00000004461 11066163237 033302 0 ustar twerner twerner package org.apache.maven.doxia.module.site.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Collection;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Map;
import org.apache.maven.doxia.module.site.SiteModule;
/**
* Simple implementation of the SiteModuleManager interface.
*
* @author Jason van Zyl
* @version $Id: DefaultSiteModuleManager.java 698165 2008-09-23 12:52:47Z vsiveton $
* @since 1.0
* @plexus.component
*/
public class DefaultSiteModuleManager
implements SiteModuleManager
{
/**
* @plexus.requirement role="org.apache.maven.doxia.module.site.SiteModule"
*/
private Map siteModules;
private Collection siteModulesValues;
/** {@inheritDoc} */
public Collection getSiteModules()
{
if ( siteModulesValues == null )
{
Map siteModulesTmp = new LinkedHashMap();
for ( Iterator it = siteModules.values().iterator(); it.hasNext(); )
{
Object obj = it.next();
siteModulesTmp.put( obj.getClass(), obj );
}
siteModulesValues = siteModulesTmp.values();
}
return siteModulesValues;
}
/** {@inheritDoc} */
public SiteModule getSiteModule( String id )
throws SiteModuleNotFoundException
{
SiteModule siteModule = (SiteModule) siteModules.get( id );
if ( siteModule == null )
{
throw new SiteModuleNotFoundException( "Cannot find site module id = " + id );
}
return siteModule;
}
}
././@LongLink 0000000 0000000 0000000 00000000161 00000000000 011563 L ustar root root doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundException.java doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/manager/SiteModuleNotFoundEx0000644 0001750 0001750 00000005132 11021234043 033270 0 ustar twerner twerner package org.apache.maven.doxia.module.site.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Encapsulate a Doxia exception that indicates that a SiteModule
* does not exist or could not be found.
*
* @author Jason van Zyl
* @version $Id: SiteModuleNotFoundException.java 662767 2008-06-03 12:25:07Z ltheussl $
* @since 1.0
*/
public class SiteModuleNotFoundException
extends Exception
{
/** serialVersionUID */
static final long serialVersionUID = 295967936746221567L;
/**
* Construct a new SiteModuleNotFoundException with the
* specified detail message.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
*/
public SiteModuleNotFoundException( String message )
{
super( message );
}
/**
* Constructs a new SiteModuleNotFoundException with the specified cause.
* The error message is (cause == null ? null : cause.toString() ).
*
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public SiteModuleNotFoundException( Throwable cause )
{
super( cause );
}
/**
* Construct a new SiteModuleNotFoundException with the specified
* detail message and cause.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param cause The cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public SiteModuleNotFoundException( String message, Throwable cause )
{
super( message, cause );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/AbstractSiteModule.java 0000644 0001750 0001750 00000004222 11213710143 032312 0 ustar twerner twerner package org.apache.maven.doxia.module.site;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* An abstract base class that implements the SiteModule interface.
*
* @author Jason van Zyl
* @version $Id: AbstractSiteModule.java 783285 2009-06-10 10:52:19Z vsiveton $
* @since 1.0
*/
public abstract class AbstractSiteModule
implements SiteModule
{
/** The source directory. */
private final String sourceDirectory;
/** The default file extension. */
private final String extension;
/** The default file extension. */
private final String parserId;
/**
* Constructor with null.
*/
public AbstractSiteModule()
{
this( null, null, null );
}
/**
* @param sourceDirectory not null
* @param extension not null
* @param parserId not null
* @since 1.1.1
*/
protected AbstractSiteModule( String sourceDirectory, String extension, String parserId )
{
super();
this.sourceDirectory = sourceDirectory;
this.extension = extension;
this.parserId = parserId;
}
/** {@inheritDoc} */
public String getSourceDirectory()
{
return sourceDirectory;
}
/** {@inheritDoc} */
public String getExtension()
{
return extension;
}
/** {@inheritDoc} */
public String getParserId()
{
return parserId;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/module/site/SiteModule.java 0000644 0001750 0001750 00000003177 11150512221 030633 0 ustar twerner twerner package org.apache.maven.doxia.module.site;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Provides definitions for a Doxia module. This is used by the doxia site tools.
*
* @author Jason van Zyl
* @version $Id: SiteModule.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public interface SiteModule
{
/** The Plexus lookup role. */
String ROLE = SiteModule.class.getName();
/**
* Returns the directory that contains source files for a given module.
*
* @return The source directory.
*/
String getSourceDirectory();
/**
* Returns the default file extension for a given module.
*
* @return The default file extension.
*/
String getExtension();
/**
* Returns the parser id for a given module.
*
* @return The parser id.
*/
String getParserId();
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/DefaultDoxia.java 0000644 0001750 0001750 00000004713 10755311026 026710 0 ustar twerner twerner package org.apache.maven.doxia;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.logging.PlexusLoggerWrapper;
import org.apache.maven.doxia.parser.ParseException;
import org.apache.maven.doxia.parser.Parser;
import org.apache.maven.doxia.parser.manager.ParserManager;
import org.apache.maven.doxia.parser.manager.ParserNotFoundException;
import org.apache.maven.doxia.sink.Sink;
import org.codehaus.plexus.logging.AbstractLogEnabled;
import java.io.Reader;
/**
* Simple implementation of the Doxia interface:
* uses a ParserManager to lookup a parser.
*
* @author Jason van Zyl
* @version $Id: DefaultDoxia.java 628059 2008-02-15 13:22:30Z vsiveton $
* @since 1.0
* @plexus.component
*/
public class DefaultDoxia
extends AbstractLogEnabled
implements Doxia
{
/** @plexus.requirement */
private ParserManager parserManager;
// ----------------------------------------------------------------------
// This remains because the sinks are not threadsafe which they probably
// should be. In some places a constructor is used to initialize a sink
// which can probably be done away with.
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void parse( Reader source, String parserId, Sink sink )
throws ParserNotFoundException, ParseException
{
Parser parser = parserManager.getParser( parserId );
parser.enableLogging( new PlexusLoggerWrapper( getLogger() ) );
parser.parse( source, sink );
}
/** {@inheritDoc} */
public Parser getParser( String parserId )
throws ParserNotFoundException
{
return parserManager.getParser( parserId );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/ 0000755 0001750 0001750 00000000000 11632765554 025001 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/XhtmlBaseParser.java 0000644 0001750 0001750 00000073632 11313470726 030711 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.Reader;
import java.util.HashMap;
import java.util.Iterator;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import javax.swing.text.html.HTML.Attribute;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.markup.HtmlMarkup;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.sink.SinkEventAttributes;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
/**
* Common base parser for xhtml events.
*
* @author Jason van Zyl
* @author ltheussl
* @version $Id: XhtmlBaseParser.java 892639 2009-12-20 18:49:58Z ltheussl $
* @since 1.1
*/
public class XhtmlBaseParser
extends AbstractXmlParser
implements HtmlMarkup
{
/** True if a <script></script> block is read. CDATA sections within are handled as rawText. */
private boolean scriptBlock;
/** Used to distinguish <a href=""> from <a name="">. */
private boolean isLink;
/** Used to distinguish <a href=""> from <a name="">. */
private boolean isAnchor;
/** Used for nested lists. */
private int orderedListDepth = 0;
/** Counts section level. */
private int sectionLevel;
/** Verbatim flag, true whenever we are inside a <pre> tag. */
private boolean inVerbatim;
/** Used to recognize the case of img inside figure. */
private boolean inFigure;
/** Decoration properties, eg for texts. */
private final SinkEventAttributeSet decoration = new SinkEventAttributeSet();
/** Map of warn messages with a String as key to describe the error type and a Set as value.
* Using to reduce warn messages. */
private Map warnMessages;
/** {@inheritDoc} */
public void parse( Reader source, Sink sink )
throws ParseException
{
init();
try
{
super.parse( source, sink );
}
finally
{
logWarnings();
setSecondParsing( false );
init();
}
}
/**
*
* Goes through a common list of possible html start tags. These include only tags that can go into
* the body of a xhtml document and so should be re-usable by different xhtml-based parsers.
*
* Goes through a common list of possible html end tags.
* These should be re-usable by different xhtml-based parsers.
* The tags handled here are the same as for {@link #baseStartTag(XmlPullParser,Sink)},
* except for the empty elements (<br/>, <hr/>, <img/>).
*
*
* @param parser A parser.
* @param sink the sink to receive the events.
* @return True if the event has been handled by this method, false otherwise.
*/
protected boolean baseEndTag( XmlPullParser parser, Sink sink )
{
boolean visited = true;
if ( parser.getName().equals( HtmlMarkup.P.toString() ) )
{
if ( !inFigure )
{
sink.paragraph_();
}
}
else if ( parser.getName().equals( HtmlMarkup.U.toString() )
|| parser.getName().equals( HtmlMarkup.S.toString() )
|| parser.getName().equals( HtmlMarkup.STRIKE.toString() )
|| parser.getName().equals( "del" ) )
{
decoration.removeAttribute( SinkEventAttributes.DECORATION );
}
else if ( parser.getName().equals( HtmlMarkup.SUB.toString() )
|| parser.getName().equals( HtmlMarkup.SUP.toString() ) )
{
decoration.removeAttribute( SinkEventAttributes.VALIGN );
}
else if ( parser.getName().equals( HtmlMarkup.DIV.toString() ) )
{
if ( inFigure )
{
sink.figure_();
this.inFigure = false;
}
else
{
visited = false;
}
}
else if ( parser.getName().equals( HtmlMarkup.PRE.toString() ) )
{
verbatim_();
sink.verbatim_();
}
else if ( parser.getName().equals( HtmlMarkup.UL.toString() ) )
{
sink.list_();
}
else if ( parser.getName().equals( HtmlMarkup.OL.toString() ) )
{
sink.numberedList_();
orderedListDepth--;
}
else if ( parser.getName().equals( HtmlMarkup.LI.toString() ) )
{
handleListItemEnd( sink );
}
else if ( parser.getName().equals( HtmlMarkup.DL.toString() ) )
{
sink.definitionList_();
}
else if ( parser.getName().equals( HtmlMarkup.DT.toString() ) )
{
sink.definedTerm_();
}
else if ( parser.getName().equals( HtmlMarkup.DD.toString() ) )
{
sink.definition_();
sink.definitionListItem_();
}
else if ( ( parser.getName().equals( HtmlMarkup.B.toString() ) )
|| ( parser.getName().equals( HtmlMarkup.STRONG.toString() ) ) )
{
sink.bold_();
}
else if ( ( parser.getName().equals( HtmlMarkup.I.toString() ) )
|| ( parser.getName().equals( HtmlMarkup.EM.toString() ) ) )
{
handleFigureCaptionEnd( sink );
}
else if ( ( parser.getName().equals( HtmlMarkup.CODE.toString() ) )
|| ( parser.getName().equals( HtmlMarkup.SAMP.toString() ) )
|| ( parser.getName().equals( HtmlMarkup.TT.toString() ) ) )
{
sink.monospaced_();
}
else if ( parser.getName().equals( HtmlMarkup.A.toString() ) )
{
handleAEnd( sink );
}
// ----------------------------------------------------------------------
// Tables
// ----------------------------------------------------------------------
else if ( parser.getName().equals( HtmlMarkup.TABLE.toString() ) )
{
sink.tableRows_();
sink.table_();
}
else if ( parser.getName().equals( HtmlMarkup.TR.toString() ) )
{
sink.tableRow_();
}
else if ( parser.getName().equals( HtmlMarkup.TH.toString() ) )
{
sink.tableHeaderCell_();
}
else if ( parser.getName().equals( HtmlMarkup.TD.toString() ) )
{
sink.tableCell_();
}
else if ( parser.getName().equals( HtmlMarkup.CAPTION.toString() ) )
{
sink.tableCaption_();
}
else if ( parser.getName().equals( HtmlMarkup.H2.toString() ) )
{
sink.sectionTitle1_();
}
else if ( parser.getName().equals( HtmlMarkup.H3.toString() ) )
{
sink.sectionTitle2_();
}
else if ( parser.getName().equals( HtmlMarkup.H4.toString() ) )
{
sink.sectionTitle3_();
}
else if ( parser.getName().equals( HtmlMarkup.H5.toString() ) )
{
sink.sectionTitle4_();
}
else if ( parser.getName().equals( HtmlMarkup.H6.toString() ) )
{
sink.sectionTitle5_();
}
else if ( parser.getName().equals( HtmlMarkup.SCRIPT.toString() ) )
{
handleUnknown( parser, sink, TAG_TYPE_END );
scriptBlock = false;
}
else
{
visited = false;
}
return visited;
}
/**
* {@inheritDoc}
*
* Just calls {@link #baseStartTag(XmlPullParser,Sink)}, this should be
* overridden by implementing parsers to include additional tags.
*/
protected void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( !baseStartTag( parser, sink ) )
{
if ( getLog().isWarnEnabled() )
{
String position = "[" + parser.getLineNumber() + ":"
+ parser.getColumnNumber() + "]";
String tag = "<" + parser.getName() + ">";
getLog().warn( "Unrecognized xml tag: " + tag + " at " + position );
}
}
}
/**
* {@inheritDoc}
*
* Just calls {@link #baseEndTag(XmlPullParser,Sink)}, this should be
* overridden by implementing parsers to include additional tags.
*/
protected void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
if ( !baseEndTag( parser, sink ) )
{
// unrecognized tag is already logged in StartTag
}
}
/** {@inheritDoc} */
protected void handleText( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String text = getText( parser );
/*
* NOTE: Don't do any whitespace trimming here. Whitespace normalization has already been performed by the
* parser so any whitespace that makes it here is significant.
*
* NOTE: text within script tags is ignored, scripting code should be embedded in CDATA.
*/
if ( StringUtils.isNotEmpty( text ) && !isScriptBlock() )
{
sink.text( text, decoration );
}
}
/** {@inheritDoc} */
protected void handleComment( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String text = getText( parser ).trim();
if ( "PB".equals( text ) )
{
sink.pageBreak();
}
else
{
sink.comment( text );
}
}
/** {@inheritDoc} */
protected void handleCdsect( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String text = getText( parser );
if ( isScriptBlock() )
{
sink.unknown( CDATA, new Object[] {new Integer( CDATA_TYPE ), text}, null );
}
else
{
sink.text( text );
}
}
/**
* Make sure sections are nested consecutively.
*
*
* HTML doesn't have any sections, only sectionTitles (<h2> etc), that means we have to
* open close any sections that are missing in between.
*
*
*
* For instance, if the following sequence is parsed:
*
* <h3></h3>
* <h6></h6>
*
* we have to insert two section starts before we open the <h6>.
* In the following sequence
*
* <h6></h6>
* <h3></h3>
*
* we have to close two sections before we open the <h3>.
*
*
*
The current level is set to newLevel afterwards.
*
* @param newLevel the new section level, all upper levels have to be closed.
* @param sink the sink to receive the events.
*/
protected void consecutiveSections( int newLevel, Sink sink )
{
closeOpenSections( newLevel, sink );
openMissingSections( newLevel, sink );
this.sectionLevel = newLevel;
}
/**
* Close open sections.
*
* @param newLevel the new section level, all upper levels have to be closed.
* @param sink the sink to receive the events.
*/
private void closeOpenSections( int newLevel, Sink sink )
{
while ( this.sectionLevel >= newLevel )
{
if ( sectionLevel == Sink.SECTION_LEVEL_5 )
{
sink.section5_();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_4 )
{
sink.section4_();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_3 )
{
sink.section3_();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_2 )
{
sink.section2_();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_1 )
{
sink.section1_();
}
this.sectionLevel--;
}
}
/**
* Open missing sections.
*
* @param newLevel the new section level, all lower levels have to be opened.
* @param sink the sink to receive the events.
*/
private void openMissingSections( int newLevel, Sink sink )
{
while ( this.sectionLevel < newLevel - 1 )
{
this.sectionLevel++;
if ( sectionLevel == Sink.SECTION_LEVEL_5 )
{
sink.section5();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_4 )
{
sink.section4();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_3 )
{
sink.section3();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_2 )
{
sink.section2();
}
else if ( sectionLevel == Sink.SECTION_LEVEL_1 )
{
sink.section1();
}
}
}
/**
* Return the current section level.
*
* @return the current section level.
*/
protected int getSectionLevel()
{
return this.sectionLevel;
}
/**
* Set the current section level.
*
* @param newLevel the new section level.
*/
protected void setSectionLevel( int newLevel )
{
this.sectionLevel = newLevel;
}
/**
* Stop verbatim mode.
*/
protected void verbatim_()
{
this.inVerbatim = false;
}
/**
* Start verbatim mode.
*/
protected void verbatim()
{
this.inVerbatim = true;
}
/**
* Checks if we are currently inside a <pre> tag.
*
* @return true if we are currently in verbatim mode.
*/
protected boolean isVerbatim()
{
return this.inVerbatim;
}
/**
* Checks if we are currently inside a <script> tag.
*
* @return true if we are currently inside <script> tags.
*
* @since 1.1.1.
*/
protected boolean isScriptBlock()
{
return this.scriptBlock;
}
/**
* Checks if the given id is a valid Doxia id and if not, returns a transformed one.
*
* @param id The id to validate.
* @return A transformed id or the original id if it was already valid.
* @see DoxiaUtils#encodeId(String)
*/
protected String validAnchor( String id )
{
if ( !DoxiaUtils.isValidId( id ) )
{
String linkAnchor = DoxiaUtils.encodeId( id, true );
String msg = "Modified invalid link: '" + id + "' to '" + linkAnchor + "'";
logMessage( "modifiedLink", msg );
return linkAnchor;
}
return id;
}
/** {@inheritDoc} */
protected void init()
{
super.init();
this.scriptBlock = false;
this.isLink = false;
this.isAnchor = false;
this.orderedListDepth = 0;
this.sectionLevel = 0;
this.inVerbatim = false;
this.inFigure = false;
while( this.decoration.getAttributeNames().hasMoreElements() )
{
this.decoration.removeAttribute( this.decoration.getAttributeNames().nextElement() );
}
this.warnMessages = null;
}
private void handleAEnd( Sink sink )
{
if ( isLink )
{
sink.link_();
isLink = false;
}
else if ( isAnchor )
{
sink.anchor_();
isAnchor = false;
}
}
private void handleAStart( XmlPullParser parser, Sink sink, SinkEventAttributeSet attribs )
{
String href = parser.getAttributeValue( null, Attribute.HREF.toString() );
if ( href != null )
{
int hashIndex = href.indexOf( "#" );
if ( hashIndex != -1 && !DoxiaUtils.isExternalLink( href ) )
{
String hash = href.substring( hashIndex + 1 );
if ( !DoxiaUtils.isValidId( hash ) )
{
href = href.substring( 0, hashIndex ) + "#" + DoxiaUtils.encodeId( hash, true );
String msg = "Modified invalid link: '" + hash + "' to '" + href + "'";
logMessage( "modifiedLink", msg );
}
}
sink.link( href, attribs );
isLink = true;
}
else
{
String name = parser.getAttributeValue( null, Attribute.NAME.toString() );
if ( name != null )
{
sink.anchor( validAnchor( name ), attribs );
isAnchor = true;
}
else
{
String id = parser.getAttributeValue( null, Attribute.ID.toString() );
if ( id != null )
{
sink.anchor( validAnchor( id ), attribs );
isAnchor = true;
}
}
}
}
private boolean handleDivStart( XmlPullParser parser, SinkEventAttributeSet attribs, Sink sink )
{
boolean visited = true;
String divclass = parser.getAttributeValue( null, Attribute.CLASS.toString() );
if ( "figure".equals( divclass ) )
{
this.inFigure = true;
SinkEventAttributeSet atts = new SinkEventAttributeSet( attribs );
atts.removeAttribute( SinkEventAttributes.CLASS );
sink.figure( atts );
}
else
{
visited = false;
}
return visited;
}
private void handleFigureCaptionEnd( Sink sink )
{
if ( inFigure )
{
sink.figureCaption_();
}
else
{
sink.italic_();
}
}
private void handleFigureCaptionStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( inFigure )
{
sink.figureCaption( attribs );
}
else
{
sink.italic();
}
}
private void handleImgStart( XmlPullParser parser, Sink sink, SinkEventAttributeSet attribs )
{
String src = parser.getAttributeValue( null, Attribute.SRC.toString() );
if ( src != null )
{
sink.figureGraphics( src, attribs );
}
}
private void handleLIStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( orderedListDepth == 0 )
{
sink.listItem( attribs );
}
else
{
sink.numberedListItem( attribs );
}
}
private void handleListItemEnd( Sink sink )
{
if ( orderedListDepth == 0 )
{
sink.listItem_();
}
else
{
sink.numberedListItem_();
}
}
private void handleOLStart( XmlPullParser parser, Sink sink, SinkEventAttributeSet attribs )
{
int numbering = Sink.NUMBERING_DECIMAL;
// this will have to be generalized if we handle styles
String style = parser.getAttributeValue( null, Attribute.STYLE.toString() );
if ( style != null )
{
if ( "list-style-type: upper-alpha".equals( style ) )
{
numbering = Sink.NUMBERING_UPPER_ALPHA;
}
else if ( "list-style-type: lower-alpha".equals( style ) )
{
numbering = Sink.NUMBERING_LOWER_ALPHA;
}
else if ( "list-style-type: upper-roman".equals( style ) )
{
numbering = Sink.NUMBERING_UPPER_ROMAN;
}
else if ( "list-style-type: lower-roman".equals( style ) )
{
numbering = Sink.NUMBERING_LOWER_ROMAN;
}
else if ( "list-style-type: decimal".equals( style ) )
{
numbering = Sink.NUMBERING_DECIMAL;
}
}
sink.numberedList( numbering, attribs );
orderedListDepth++;
}
private void handlePStart( Sink sink, SinkEventAttributeSet attribs )
{
if ( !inFigure )
{
sink.paragraph( attribs );
}
}
/*
* The PRE element tells visual user agents that the enclosed text is
* "preformatted". When handling preformatted text, visual user agents:
* - May leave white space intact.
* - May render text with a fixed-pitch font.
* - May disable automatic word wrap.
* - Must not disable bidirectional processing.
* Non-visual user agents are not required to respect extra white space
* in the content of a PRE element.
*/
private void handlePreStart( SinkEventAttributeSet attribs, Sink sink )
{
verbatim();
attribs.removeAttribute( SinkEventAttributes.DECORATION );
sink.verbatim( attribs );
}
private void handleSectionStart( Sink sink, int level, SinkEventAttributeSet attribs )
{
consecutiveSections( level, sink );
sink.section( level, attribs );
sink.sectionTitle( level, attribs );
}
private void handleTableStart( Sink sink, SinkEventAttributeSet attribs, XmlPullParser parser )
{
sink.table( attribs );
String border = parser.getAttributeValue( null, Attribute.BORDER.toString() );
boolean grid = true;
if ( border == null || "0".equals( border ) )
{
grid = false;
}
String align = parser.getAttributeValue( null, Attribute.ALIGN.toString() );
int[] justif = {Sink.JUSTIFY_LEFT};
if ( "center".equals( align ) )
{
justif[0] = Sink.JUSTIFY_CENTER;
}
else if ( "right".equals( align ) )
{
justif[0] = Sink.JUSTIFY_RIGHT;
}
sink.tableRows( justif, grid );
}
/**
* If debug mode is enabled, log the msg as is, otherwise add unique msg in warnMessages.
*
* @param key not null
* @param msg not null
* @see #parse(Reader, Sink)
* @since 1.1.1
*/
private void logMessage( String key, String msg )
{
msg = "[XHTML Parser] " + msg;
if ( getLog().isDebugEnabled() )
{
getLog().debug( msg );
return;
}
if ( warnMessages == null )
{
warnMessages = new HashMap();
}
Set set = (Set) warnMessages.get( key );
if ( set == null )
{
set = new TreeSet();
}
set.add( msg );
warnMessages.put( key, set );
}
/**
* @since 1.1.1
*/
private void logWarnings()
{
if ( getLog().isWarnEnabled() && this.warnMessages != null && !isSecondParsing() )
{
for ( Iterator it = this.warnMessages.entrySet().iterator(); it.hasNext(); )
{
Map.Entry entry = (Map.Entry) it.next();
Set set = (Set) entry.getValue();
for ( Iterator it2 = set.iterator(); it2.hasNext(); )
{
String msg = (String) it2.next();
getLog().warn( msg );
}
}
this.warnMessages = null;
}
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ 0000755 0001750 0001750 00000000000 11632765554 026413 5 ustar twerner twerner ././@LongLink 0000000 0000000 0000000 00000000145 00000000000 011565 L ustar root root doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/DefaultParserManager.java0000644 0001750 0001750 00000003241 11150512221 033262 0 ustar twerner twerner package org.apache.maven.doxia.parser.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.Parser;
import java.util.Map;
/**
* Simple implementation of the ParserManager interface.
*
* @author Jason van Zyl
* @version $Id: DefaultParserManager.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
* @plexus.component
*/
public class DefaultParserManager
implements ParserManager
{
/**
* @plexus.requirement role="org.apache.maven.doxia.parser.Parser"
*/
private Map parsers;
/** {@inheritDoc} */
public Parser getParser( String id )
throws ParserNotFoundException
{
Parser parser = (Parser) parsers.get( id );
if ( parser == null )
{
throw new ParserNotFoundException( "Cannot find parser with id = " + id );
}
return parser;
}
}
././@LongLink 0000000 0000000 0000000 00000000150 00000000000 011561 L ustar root root doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.java doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserNotFoundException.j0000644 0001750 0001750 00000005034 11021234043 033330 0 ustar twerner twerner package org.apache.maven.doxia.parser.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Encapsulate a Doxia exception that indicates that a parser
* does not exist or could not be found.
*
* @author Jason van Zyl
* @version $Id: ParserNotFoundException.java 662767 2008-06-03 12:25:07Z ltheussl $
* @since 1.0
*/
public class ParserNotFoundException
extends Exception
{
/** serialVersionUID */
static final long serialVersionUID = 295967936746221567L;
/**
* Construct a new ParserNotFoundException with the specified detail message.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
*/
public ParserNotFoundException( String message )
{
super( message );
}
/**
* Constructs a new exception with the specified cause. The error
* message is (cause == null ? null : cause.toString() ).
*
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public ParserNotFoundException( Throwable cause )
{
super( cause );
}
/**
* Construct a new ParserNotFoundException with the specified
* detail message and cause.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param cause the cause. This can be retrieved later by the
* Throwable.getCause() method. (A null value is permitted, and indicates
* that the cause is nonexistent or unknown.)
*/
public ParserNotFoundException( String message, Throwable cause )
{
super( message, cause );
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/manager/ParserManager.java 0000644 0001750 0001750 00000003045 11150512221 031757 0 ustar twerner twerner package org.apache.maven.doxia.parser.manager;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.parser.Parser;
/**
* Handles parser lookups.
*
* @author Jason van Zyl
* @version $Id: ParserManager.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public interface ParserManager
{
/** The Plexus lookup role. */
String ROLE = ParserManager.class.getName();
/**
* Returns the parser that corresponds to the given id.
*
* @param id The identifier.
* @return The corresponding parser.
* @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException if no parser could be found
* for the given id.
*/
Parser getParser( String id )
throws ParserNotFoundException;
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractParser.java 0000644 0001750 0001750 00000012405 11375443016 030554 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.File;
import java.io.StringReader;
import org.apache.maven.doxia.logging.Log;
import org.apache.maven.doxia.logging.SystemStreamLog;
import org.apache.maven.doxia.macro.Macro;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.macro.MacroRequest;
import org.apache.maven.doxia.macro.manager.MacroManager;
import org.apache.maven.doxia.macro.manager.MacroNotFoundException;
import org.apache.maven.doxia.sink.Sink;
/**
* An abstract base class that defines some convenience methods for parsers.
* Provides a macro mechanism to give dynamic functionalities for the parsing.
*
* @author Jason van Zyl
* @version $Id: AbstractParser.java 946932 2010-05-21 08:36:30Z ltheussl $
* @since 1.0
* @plexus.component
*/
public abstract class AbstractParser
implements Parser
{
/** Indicates that a second parsing is required. */
private boolean secondParsing = false;
/** @plexus.requirement */
private MacroManager macroManager;
/** Log instance. */
private Log logger;
/** {@inheritDoc} */
public int getType()
{
return UNKNOWN_TYPE;
}
/**
* Execute a macro on the given sink.
*
* @param macroId An id to lookup the macro.
* @param request The corresponding MacroRequest.
* @param sink The sink to receive the events.
* @throws org.apache.maven.doxia.macro.MacroExecutionException if an error occurred during execution.
* @throws org.apache.maven.doxia.macro.manager.MacroNotFoundException if the macro could not be found.
*/
// Made public right now because of the structure of the APT parser and
// all its inner classes.
public void executeMacro( String macroId, MacroRequest request, Sink sink )
throws MacroExecutionException, MacroNotFoundException
{
Macro macro = getMacroManager().getMacro( macroId );
macro.enableLogging( getLog() );
macro.execute( sink, request );
}
/**
* Returns the current base directory.
*
* @return The base directory.
*
* @deprecated this does not work in multi-module builds, see DOXIA-373
*/
protected File getBasedir()
{
// TODO: This is baaad, it should come in with the request.
// (this is only used for macro requests, see AptParser)
String basedir = System.getProperty( "basedir" );
if ( basedir != null )
{
return new File( basedir );
}
return new File( new File( "" ).getAbsolutePath() );
}
/**
* Convenience method to parse an arbitrary string and emit events into the given sink.
*
* @param string A string that provides the source input.
* @param sink A sink that consumes the Doxia events.
* @throws org.apache.maven.doxia.parser.ParseException if the string could not be parsed.
* @since 1.1
*/
public void parse( String string, Sink sink )
throws ParseException
{
parse( new StringReader( string ), sink );
}
/**
* Set secondParsing to true, if we need a second parsing.
*
* @param second True for second parsing.
*/
public void setSecondParsing( boolean second )
{
this.secondParsing = second;
}
/**
* Indicates if we are currently parsing a second time.
*
* @return true if we are currently parsing a second time.
* @since 1.1
*/
protected boolean isSecondParsing()
{
return secondParsing;
}
/** {@inheritDoc} */
public void enableLogging( Log log )
{
this.logger = log;
}
/**
* Returns the current logger for this parser.
* If no logger has been configured yet, a new SystemStreamLog is returned.
*
* @return Log
* @since 1.1
*/
protected Log getLog()
{
if ( logger == null )
{
logger = new SystemStreamLog();
}
return logger;
}
/**
* Gets the current {@link MacroManager}.
*
* @return The current {@link MacroManager}.
* @since 1.1
*/
protected MacroManager getMacroManager()
{
return macroManager;
}
/**
* Initialize the parser. This is called first by
* {@link #parse(java.io.Reader, org.apache.maven.doxia.sink.Sink)} and can be used
* to set the parser into a clear state so it can be re-used.
*
* @since 1.1.2
*/
protected void init()
{
// nop
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/Parser.java 0000644 0001750 0001750 00000004345 11150512221 027056 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.logging.LogEnabled;
import org.apache.maven.doxia.sink.Sink;
import java.io.Reader;
/**
* A Parser is responsible for parsing any document in a supported front-end
* format, and emitting the standard Doxia events, which can then be consumed
* by any Doxia Sink.
*
* @author Jason van Zyl
* @version $Id: Parser.java 746978 2009-02-23 12:20:33Z vsiveton $
* @since 1.0
*/
public interface Parser
extends LogEnabled
{
/** The Plexus lookup role. */
String ROLE = Parser.class.getName();
/** Unknown parser type */
int UNKNOWN_TYPE = 0;
/** Text parser type */
int TXT_TYPE = 1;
/** XML parser type */
int XML_TYPE = 2;
/**
* Parses the given source model and emits Doxia events into the given sink.
*
* @param source not null reader that provides the source document.
* You could use newReader methods from {@link org.codehaus.plexus.util.ReaderFactory}.
* @param sink A sink that consumes the Doxia events.
* @throws org.apache.maven.doxia.parser.ParseException if the model could not be parsed.
*/
void parse( Reader source, Sink sink )
throws ParseException;
/**
* The parser type value could be {@link #UNKNOWN_TYPE}, {@link #TXT_TYPE} or
* {@link #XML_TYPE}.
*
* @return the type of Parser
*/
int getType();
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractTextParser.java 0000644 0001750 0001750 00000002517 10767707462 031440 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.markup.TextMarkup;
/**
* An abstract class that defines some convenience methods for Text parsers.
*
* @author Vincent Siveton
* @version $Id: AbstractTextParser.java 638290 2008-03-18 09:45:22Z bentmann $
* @since 1.0
*/
public abstract class AbstractTextParser
extends AbstractParser
implements TextMarkup
{
/** {@inheritDoc} */
public final int getType()
{
return TXT_TYPE;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/ParseException.java 0000644 0001750 0001750 00000021436 11151246713 030566 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* Encapsulate a Doxia parse error.
*
* @author Jason van Zyl
* @version $Id: ParseException.java 747780 2009-02-25 13:55:23Z vsiveton $
* @since 1.0
*/
public class ParseException
extends Exception
{
/** serialVersionUID */
static final long serialVersionUID = 295967936746221567L;
/** The file that caused the ParseException. */
private String fileName;
/** Line number where the parse exception occurred. */
private int lineNumber;
/** Column number where the parse exception occurred. */
private int columnNumber;
/**
* Construct a new ParseException with the specified detail message.
*
* Note: no line or column number will be used.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
*/
public ParseException( String message )
{
this( null, message, null, -1, -1 );
}
/**
* Construct a new ParseException with the specified detail message and cause.
*
* Note: no line or column number will be used.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
*/
public ParseException( String message, Exception e )
{
this( e, message, null, -1, -1 );
}
/**
* Construct a new ParseException with the specified detail message,
* line number and column number.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
* @since 1.1
*/
public ParseException( String message, int line, int column )
{
this( null, message, null, line, column );
}
/**
* Construct a new ParseException with the specified detail message and cause,
* line number and column number.
*
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
* @since 1.1
*/
public ParseException( String message, Exception e, int line, int column )
{
this( e, message, null, line, column );
}
/**
* Constructs a new exception with the specified cause. The error message is
* (cause == null ? null : cause.toString() ).
*
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @deprecated Using {@link #ParseException(Exception, int, int)} to specify the line and column number.
*/
public ParseException( Exception e )
{
this( e, null, null, -1, -1 );
}
/**
* Constructs a new exception with the specified cause, line number and column number. The error message is
* (cause == null ? null : cause.toString() ).
*
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
* @since 1.1
*/
public ParseException( Exception e, int line, int column )
{
this( e, null, null, line, column );
}
/**
* Construct a new ParseException with the specified cause,
* filename and linenumber.
*
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param file Name of a file that couldn't be parsed.
* This can later be retrieved by the getFileName() method.
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @deprecated Using {@link #ParseException(Exception, String, int, int)} to specify the column number.
*/
public ParseException( Exception e, String file, int line )
{
this( e, null, file, line, -1 );
}
/**
* Construct a new ParseException with the specified cause,
* filename, line number and column number.
*
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param file Name of a file that couldn't be parsed.
* This can later be retrieved by the getFileName() method.
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
*/
public ParseException( Exception e, String file, int line, int column )
{
this( e, null, file, line, column );
}
/**
* Construct a new ParseException with the specified cause, detail message,
* filename, line number and column number.
*
* @param e the cause. This can be retrieved later by the Throwable.getCause() method.
* (A null value is permitted, and indicates that the cause is nonexistent or unknown.)
* @param message The detailed message.
* This can later be retrieved by the Throwable.getMessage() method.
* @param file Name of a file that couldn't be parsed.
* This can later be retrieved by the getFileName() method.
* @param line The line number where the parsing failed.
* This can later be retrieved by the getLineNumber() method.
* @param column The column number where the parsing failed.
* This can later be retrieved by the getColumnNumber() method.
* @since 1.1
*/
public ParseException( Exception e, String message, String file, int line, int column )
{
super( ( message == null ) ? ( ( e == null ) ? null : e.getMessage() ) : message, e );
this.fileName = file;
this.lineNumber = line;
this.columnNumber = column;
}
/**
*
Getter for the field fileName.
*
* @return the file name that caused the ParseException.
*/
public String getFileName()
{
return fileName;
}
/**
*
Getter for the field lineNumber.
*
* @return the line number where the ParseException occurred.
*/
public int getLineNumber()
{
return lineNumber;
}
/**
*
Getter for the field columnNumber.
*
* @return the column number where the ParseException occurred.
* @since 1.1
*/
public int getColumnNumber()
{
return columnNumber;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/parser/AbstractXmlParser.java 0000644 0001750 0001750 00000072006 11470551025 031234 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.io.Reader;
import java.io.StringReader;
import java.net.URL;
import java.util.Hashtable;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.Locale;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.HttpStatus;
import org.apache.http.client.ClientProtocolException;
import org.apache.http.client.HttpRequestRetryHandler;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.impl.client.DefaultHttpClient;
import org.apache.http.impl.client.DefaultHttpRequestRetryHandler;
import org.apache.http.util.EntityUtils;
import org.apache.maven.doxia.macro.MacroExecutionException;
import org.apache.maven.doxia.markup.XmlMarkup;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkEventAttributeSet;
import org.apache.maven.doxia.util.HtmlTools;
import org.apache.maven.doxia.util.XmlValidator;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.IOUtil;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.pull.MXParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParser;
import org.codehaus.plexus.util.xml.pull.XmlPullParserException;
import org.xml.sax.EntityResolver;
import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
/**
* An abstract class that defines some convenience methods for XML parsers.
*
* @author Vincent Siveton
* @version $Id: AbstractXmlParser.java 1035744 2010-11-16 18:48:53Z dennisl $
* @since 1.0
*/
public abstract class AbstractXmlParser
extends AbstractParser
implements XmlMarkup
{
/**
* Entity pattern for HTML entity, i.e.
* "|^\\s]+)(\\s)+\"(\\s)*(&[a-zA-Z]{2,6};)(\\s)*\"(\\s)*>
*
* see http://www.w3.org/TR/REC-xml/#NT-EntityDecl.
*/
private static final Pattern PATTERN_ENTITY_1 =
Pattern.compile( ENTITY_START + "(\\s)+([^>|^\\s]+)(\\s)+\"(\\s)*(&[a-zA-Z]{2,6};)(\\s)*\"(\\s)*>" );
/**
* Entity pattern for Unicode entity, i.e. &
* "|^\\s]+)(\\s)+\"(\\s)*(&(#x?[0-9a-fA-F]{1,5};)*)(\\s)*\"(\\s)*>"
*
* see http://www.w3.org/TR/REC-xml/#NT-EntityDecl.
*/
private static final Pattern PATTERN_ENTITY_2 =
Pattern.compile( ENTITY_START + "(\\s)+([^>|^\\s]+)(\\s)+\"(\\s)*(&(#x?[0-9a-fA-F]{1,5};)*)(\\s)*\"(\\s)*>" );
private boolean ignorableWhitespace;
private boolean collapsibleWhitespace;
private boolean trimmableWhitespace;
private Map entities;
private boolean validate = false;
/** {@inheritDoc} */
public void parse( Reader source, Sink sink )
throws ParseException
{
init();
// 1 first parsing if validation is required
if ( isValidate() )
{
String content;
try
{
content = IOUtil.toString( new BufferedReader( source ) );
}
catch ( IOException e )
{
throw new ParseException( "Error reading the model: " + e.getMessage(), e );
}
new XmlValidator( getLog() ).validate( content );
source = new StringReader( content );
}
// 2 second parsing to process
try
{
XmlPullParser parser = new MXParser();
parser.setInput( source );
sink.enableLogging( getLog() );
parseXml( parser, sink );
}
catch ( XmlPullParserException ex )
{
throw new ParseException( "Error parsing the model: " + ex.getMessage(), ex, ex.getLineNumber(),
ex.getColumnNumber() );
}
catch ( MacroExecutionException ex )
{
throw new ParseException( "Macro execution failed: " + ex.getMessage(), ex );
}
setSecondParsing( false );
init();
}
/**
* {@inheritDoc}
*
* Convenience method to parse an arbitrary string and emit any xml events into the given sink.
*/
public void parse( String string, Sink sink )
throws ParseException
{
super.parse( string, sink );
}
/** {@inheritDoc} */
public final int getType()
{
return XML_TYPE;
}
/**
* Converts the attributes of the current start tag of the given parser to a SinkEventAttributeSet.
*
* @param parser A parser, not null.
* @return a SinkEventAttributeSet or null if the current parser event is not a start tag.
* @since 1.1
*/
protected SinkEventAttributeSet getAttributesFromParser( XmlPullParser parser )
{
int count = parser.getAttributeCount();
if ( count < 0 )
{
return null;
}
SinkEventAttributeSet atts = new SinkEventAttributeSet( count );
for ( int i = 0; i < count; i++ )
{
atts.addAttribute( parser.getAttributeName( i ), parser.getAttributeValue( i ) );
}
return atts;
}
/**
* Parse the model from the XmlPullParser into the given sink.
*
* @param parser A parser, not null.
* @param sink the sink to receive the events.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
* @throws org.apache.maven.doxia.macro.MacroExecutionException if there's a problem executing a macro
*/
private void parseXml( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException
{
int eventType = parser.getEventType();
while ( eventType != XmlPullParser.END_DOCUMENT )
{
if ( eventType == XmlPullParser.START_TAG )
{
handleStartTag( parser, sink );
}
else if ( eventType == XmlPullParser.END_TAG )
{
handleEndTag( parser, sink );
}
else if ( eventType == XmlPullParser.TEXT )
{
String text = getText( parser );
if ( isIgnorableWhitespace() )
{
if ( !text.trim().equals( "" ) )
{
handleText( parser, sink );
}
}
else
{
handleText( parser, sink );
}
}
else if ( eventType == XmlPullParser.CDSECT )
{
handleCdsect( parser, sink );
}
else if ( eventType == XmlPullParser.COMMENT )
{
handleComment( parser, sink );
}
else if ( eventType == XmlPullParser.ENTITY_REF )
{
handleEntity( parser, sink );
}
else if ( eventType == XmlPullParser.IGNORABLE_WHITESPACE )
{
// nop
}
else if ( eventType == XmlPullParser.PROCESSING_INSTRUCTION )
{
// nop
}
else if ( eventType == XmlPullParser.DOCDECL )
{
addLocalEntities( parser, parser.getText() );
for ( Iterator it = CachedFileEntityResolver.ENTITY_CACHE.values().iterator(); it.hasNext(); )
{
byte[] res = (byte[]) it.next();
addDTDEntities( parser, new String( res ) );
}
}
try
{
eventType = parser.nextToken();
}
catch ( IOException io )
{
throw new XmlPullParserException( "IOException: " + io.getMessage(), parser, io );
}
}
}
/**
* Goes through the possible start tags.
*
* @param parser A parser, not null.
* @param sink the sink to receive the events.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
* @throws org.apache.maven.doxia.macro.MacroExecutionException if there's a problem executing a macro
*/
protected abstract void handleStartTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException;
/**
* Goes through the possible end tags.
*
* @param parser A parser, not null.
* @param sink the sink to receive the events.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
* @throws org.apache.maven.doxia.macro.MacroExecutionException if there's a problem executing a macro
*/
protected abstract void handleEndTag( XmlPullParser parser, Sink sink )
throws XmlPullParserException, MacroExecutionException;
/**
* Handles text events.
*
*
This is a default implementation, if the parser points to a non-empty text element,
* it is emitted as a text event into the specified sink.
*
* @param parser A parser, not null.
* @param sink the sink to receive the events. Not null.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
*/
protected void handleText( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String text = getText( parser );
/*
* NOTE: Don't do any whitespace trimming here. Whitespace normalization has already been performed by the
* parser so any whitespace that makes it here is significant.
*/
if ( StringUtils.isNotEmpty( text ) )
{
sink.text( text );
}
}
/**
* Handles CDATA sections.
*
*
This is a default implementation, all data are emitted as text
* events into the specified sink.
*
* @param parser A parser, not null.
* @param sink the sink to receive the events. Not null.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
*/
protected void handleCdsect( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
sink.text( getText( parser ) );
}
/**
* Handles comments.
*
*
This is a default implementation, all data are emitted as comment
* events into the specified sink.
*
* @param parser A parser, not null.
* @param sink the sink to receive the events. Not null.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
*/
protected void handleComment( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
sink.comment( getText( parser ).trim() );
}
/**
* Handles entities.
*
*
This is a default implementation, all entities are resolved and emitted as text
* events into the specified sink, except:
*
*
the entities with names #160, nbsp and #x00A0
* are emitted as nonBreakingSpace() events.
*
*
* @param parser A parser, not null.
* @param sink the sink to receive the events. Not null.
* @throws org.codehaus.plexus.util.xml.pull.XmlPullParserException if there's a problem parsing the model
*/
protected void handleEntity( XmlPullParser parser, Sink sink )
throws XmlPullParserException
{
String text = getText( parser );
String name = parser.getName();
if ( "#160".equals( name ) || "nbsp".equals( name ) || "#x00A0".equals( name ) )
{
sink.nonBreakingSpace();
}
else
{
String unescaped = HtmlTools.unescapeHTML( text );
sink.text( unescaped );
}
}
/**
* Handles an unkown event.
*
*
This is a default implementation, all events are emitted as unknown
* events into the specified sink.
*
* @param parser the parser to get the event from.
* @param sink the sink to receive the event.
* @param type the tag event type. This should be one of HtmlMarkup.TAG_TYPE_SIMPLE,
* HtmlMarkup.TAG_TYPE_START, HtmlMarkup.TAG_TYPE_END or HtmlMarkup.ENTITY_TYPE.
* It will be passed as the first argument of the required parameters to the Sink
* {@link org.apache.maven.doxia.sink.Sink#unknown(String, Object[], org.apache.maven.doxia.sink.SinkEventAttributes)}
* method.
*/
protected void handleUnknown( XmlPullParser parser, Sink sink, int type )
{
Object[] required = new Object[] { new Integer( type ) };
SinkEventAttributeSet attribs = getAttributesFromParser( parser );
sink.unknown( parser.getName(), required, attribs );
}
/**
*
isIgnorableWhitespace.
*
* @return true if whitespace will be ignored, false otherwise.
* @see #setIgnorableWhitespace(boolean)
* @since 1.1
*/
protected boolean isIgnorableWhitespace()
{
return ignorableWhitespace;
}
/**
* Specify that whitespace will be ignored. I.e.:
*
*
* @return true if text will collapse, false otherwise.
* @see #setCollapsibleWhitespace(boolean)
* @since 1.1
*/
protected boolean isCollapsibleWhitespace()
{
return collapsibleWhitespace;
}
/**
* Specify that text will be collapsed. I.e.:
*
*
* @return true if text will be trim, false otherwise.
* @see #setTrimmableWhitespace(boolean)
* @since 1.1
*/
protected boolean isTrimmableWhitespace()
{
return trimmableWhitespace;
}
/**
* Specify that text will be collapsed. I.e.:
*
*
* @return a map of the defined entities in a local doctype.
* @since 1.1
*/
protected Map getLocalEntities()
{
if ( entities == null )
{
entities = new LinkedHashMap();
}
return entities;
}
/**
*
isValidate.
*
* @return true if XML content will be validate, false otherwise.
* @since 1.1
*/
public boolean isValidate()
{
return validate;
}
/**
* Specify a flag to validate or not the XML content.
*
* @param validate the validate to set
* @see #parse(Reader, Sink)
* @since 1.1
*/
public void setValidate( boolean validate )
{
this.validate = validate;
}
// ----------------------------------------------------------------------
// Private methods
// ----------------------------------------------------------------------
/**
* Add an entity given by entityName and entityValue to {@link #entities}.
*
* By default, we exclude the default XML entities: &, <, >, " and '.
*
* @param parser not null
* @param entityName not null
* @param entityValue not null
* @throws XmlPullParserException if any
* @see {@link XmlPullParser#defineEntityReplacementText(String, String)}
*/
private void addEntity( XmlPullParser parser, String entityName, String entityValue )
throws XmlPullParserException
{
if ( entityName.endsWith( "amp" ) || entityName.endsWith( "lt" ) || entityName.endsWith( "gt" )
|| entityName.endsWith( "quot" ) || entityName.endsWith( "apos" ) )
{
return;
}
parser.defineEntityReplacementText( entityName, entityValue );
getLocalEntities().put( entityName, entityValue );
}
/**
* Handle entities defined in a local doctype as the following:
*
*
* @param parser not null
* @param text not null
* @throws XmlPullParserException if any
*/
private void addLocalEntities( XmlPullParser parser, String text )
throws XmlPullParserException
{
int entitiesCount = StringUtils.countMatches( text, ENTITY_START );
if ( entitiesCount > 0 )
{
// text should be foo [...]
int start = text.indexOf( "[" );
int end = text.lastIndexOf( "]" );
if ( start != -1 && end != -1 )
{
text = text.substring( start + 1, end );
addDTDEntities( parser, text );
}
}
}
/**
* Handle entities defined in external doctypes as the following:
*
* <!DOCTYPE foo [
* <!-- These are the entity sets for ISO Latin 1 characters for the XHTML -->
* <!ENTITY % HTMLlat1 PUBLIC "-//W3C//ENTITIES Latin 1 for XHTML//EN"
* "http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent">
* %HTMLlat1;
* ]>
*
*
* @param parser not null
* @param text not null
* @throws XmlPullParserException if any
*/
private void addDTDEntities( XmlPullParser parser, String text )
throws XmlPullParserException
{
int entitiesCount = StringUtils.countMatches( text, ENTITY_START );
if ( entitiesCount > 0 )
{
text = StringUtils.replace( text, ENTITY_START, "\n" + ENTITY_START );
BufferedReader reader = new BufferedReader( new StringReader( text ) );
String line;
String tmpLine = "";
try
{
Matcher matcher;
while ( ( line = reader.readLine() ) != null )
{
tmpLine += "\n" + line;
matcher = PATTERN_ENTITY_1.matcher( tmpLine );
if ( matcher.find() && matcher.groupCount() == 7 )
{
String entityName = matcher.group( 2 );
String entityValue = matcher.group( 5 );
addEntity( parser, entityName, entityValue );
tmpLine = "";
}
else
{
matcher = PATTERN_ENTITY_2.matcher( tmpLine );
if ( matcher.find() && matcher.groupCount() == 8 )
{
String entityName = matcher.group( 2 );
String entityValue = matcher.group( 5 );
addEntity( parser, entityName, entityValue );
tmpLine = "";
}
}
}
}
catch ( IOException e )
{
// nop
}
finally
{
IOUtil.close( reader );
}
}
}
/**
* Implementation of the callback mechanism EntityResolver.
* Using a mechanism of cached files in temp dir to improve performance when using the XMLReader.
*/
public static class CachedFileEntityResolver
implements EntityResolver
{
/** Map with systemId as key and the content of systemId as byte[]. */
protected static final Map ENTITY_CACHE = new Hashtable();
/** {@inheritDoc} */
public InputSource resolveEntity( String publicId, String systemId )
throws SAXException, IOException
{
byte[] res = (byte[]) ENTITY_CACHE.get( systemId );
// already cached?
if ( res == null )
{
String systemName = FileUtils.getFile( systemId ).getName();
File temp = new File( System.getProperty( "java.io.tmpdir" ), systemName );
// maybe already as a temp file?
if ( !temp.exists() )
{
// is systemId a file or an url?
if ( systemId.toLowerCase( Locale.ENGLISH ).startsWith( "file" ) )
{
// Doxia XSDs are included in the jars, so try to find the resource systemName from
// the classpath...
String resource = "/" + systemName;
URL url = getClass().getResource( resource );
if ( url != null )
{
res = toByteArray( url );
}
else
{
throw new SAXException( "Could not find the SYSTEM entity: " + systemId
+ " because '" + resource + "' is not available of the classpath." );
}
}
else
{
res = toByteArray( new URL( systemId ) );
}
// write systemId as temp file
copy( res, temp );
}
else
{
// TODO How to refresh Doxia XSDs from temp dir?
res = toByteArray( temp.toURI().toURL() );
}
ENTITY_CACHE.put( systemId, res );
}
InputSource is = new InputSource( new ByteArrayInputStream( res ) );
is.setPublicId( publicId );
is.setSystemId( systemId );
return is;
}
/**
* If url is not an http/https urls, call {@link IOUtil#toByteArray(java.io.InputStream)} to get the url
* content.
* Otherwise, use HttpClient to get the http content.
* Wrap all internal exceptions to throw SAXException.
*
* @param url not null
* @return return an array of byte
* @throws SAXException if any
*/
private static byte[] toByteArray( URL url )
throws SAXException
{
if ( !( url.getProtocol().equalsIgnoreCase( "http" ) || url.getProtocol().equalsIgnoreCase( "https" ) ) )
{
InputStream is = null;
try
{
is = url.openStream();
if ( is == null )
{
throw new SAXException( "Cannot open stream from the url: " + url.toString() );
}
return IOUtil.toByteArray( is );
}
catch ( IOException e )
{
throw new SAXException( "IOException: " + e.getMessage(), e );
}
finally
{
IOUtil.close( is );
}
}
// it is an HTTP url, using HttpClient...
DefaultHttpClient client = new DefaultHttpClient();
HttpGet method = new HttpGet( url.toString() );
// Set a user-agent that doesn't contain the word "java", otherwise it will be blocked by the W3C
// The default user-agent is "Apache-HttpClient/4.0.2 (java 1.5)"
method.setHeader( "user-agent", "Apache-Doxia/1.1.4" );
HttpRequestRetryHandler retryHandler = new DefaultHttpRequestRetryHandler( 3, false );
client.setHttpRequestRetryHandler(retryHandler);
HttpEntity entity = null;
try
{
HttpResponse response = client.execute( method );
int statusCode = response.getStatusLine().getStatusCode();
if ( statusCode != HttpStatus.SC_OK )
{
throw new IOException( "The status code when accessing the URL '" + url.toString() + "' was "
+ statusCode + ", which is not allowed. The server gave this reason for the failure '"
+ response.getStatusLine().getReasonPhrase() + "'.");
}
entity = response.getEntity();
return EntityUtils.toByteArray( entity );
}
catch ( ClientProtocolException e )
{
throw new SAXException( "ClientProtocolException: Fatal protocol violation: " + e.getMessage(), e );
}
catch ( IOException e )
{
throw new SAXException( "IOException: Fatal transport error: " + e.getMessage(), e );
}
finally
{
if ( entity != null ) {
try
{
entity.consumeContent();
}
catch ( IOException e )
{
// Ignore
}
}
}
}
/**
* Wrap {@link IOUtil#copy(byte[], OutputStream)} to throw SAXException.
*
* @param res not null array of byte
* @param f the file where to write the bytes
* @throws SAXException if any
* @see {@link IOUtil#copy(byte[], OutputStream)}
*/
private void copy( byte[] res, File f )
throws SAXException
{
if ( f.isDirectory() )
{
throw new SAXException( "'" + f.getAbsolutePath() + "' is a directory, can not write it." );
}
OutputStream os = null;
try
{
os = new FileOutputStream( f );
IOUtil.copy( res, os );
}
catch ( IOException e )
{
throw new SAXException( "IOException: " + e.getMessage(), e );
}
finally
{
IOUtil.close( os );
}
}
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/markup/ 0000755 0001750 0001750 00000000000 11632765553 025003 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/markup/TextMarkup.java 0000644 0001750 0001750 00000002537 10767707462 027764 0 ustar twerner twerner package org.apache.maven.doxia.markup;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* List of constants used by Text markup syntax.
*
* @author Vincent Siveton
* @version $Id: TextMarkup.java 638290 2008-03-18 09:45:22Z bentmann $
* @since 1.0
*/
public interface TextMarkup
extends Markup
{
// ----------------------------------------------------------------------
// Text separator characters
// ----------------------------------------------------------------------
/** pipe character: '|' */
char PIPE = '|';
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/markup/Markup.java 0000644 0001750 0001750 00000004436 11014267211 027072 0 ustar twerner twerner package org.apache.maven.doxia.markup;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* List of constants used by all markup syntax.
*
* @author Vincent Siveton
* @version $Id: Markup.java 657808 2008-05-19 12:11:53Z ltheussl $
* @since 1.0
*/
public interface Markup
{
/** The vm line separator */
String EOL = System.getProperty( "line.separator" );
// ----------------------------------------------------------------------
// Generic separator characters
// ----------------------------------------------------------------------
/** equal character: '=' */
char EQUAL = '=';
/** end character: '>' */
char GREATER_THAN = '>';
/** left curly bracket character: '{' */
char LEFT_CURLY_BRACKET = '{';
/** left square bracket character: '[' */
char LEFT_SQUARE_BRACKET = '[';
/** start character: '<' */
char LESS_THAN = '<';
/** minus character: '-' */
char MINUS = '-';
/** plus character: '+' */
char PLUS = '+';
/** double quote character: '\"' */
char QUOTE = '\"';
/** right curly bracket character: '}' */
char RIGHT_CURLY_BRACKET = '}';
/** right square bracket character: ']' */
char RIGHT_SQUARE_BRACKET = ']';
/** slash character: '/' */
char SLASH = '/';
/** space character: ' ' */
char SPACE = ' ';
/** star character: '*' */
char STAR = '*';
/** colon character: ':' */
char COLON = ':';
/** semicolon character: ';' */
char SEMICOLON = ';';
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/markup/HtmlMarkup.java 0000644 0001750 0001750 00000024577 11207503365 027736 0 ustar twerner twerner package org.apache.maven.doxia.markup;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.html.HTML.Tag;
/**
* List of Html tags.
*
* This should contain all valid XHTML 1.0 tags, comprising the tags in
* {@link javax.swing.text.html.HTML.Tag} plus several others.
*
*
* @see http://www.w3.org/TR/html401/index/elements.html
*
* @author ltheussl
* @version $Id: HtmlMarkup.java 779585 2009-05-28 12:43:33Z ltheussl $
* @since 1.0
*/
public interface HtmlMarkup
extends XmlMarkup
{
/** A simple HTML tag. Eg <br/>. */
int TAG_TYPE_SIMPLE = 1;
/** A start HTML tag. Eg <p>. */
int TAG_TYPE_START = 2;
/** An end HTML tag. Eg </p>. */
int TAG_TYPE_END = 3;
/**
* An HTML entity. Eg <.
*
* @since 1.1.1.
*/
int ENTITY_TYPE = 4;
/**
* A CDATA type event.
*
* @since 1.1.1.
*/
int CDATA_TYPE = 5;
// ----------------------------------------------------------------------
// All XHTML 1.0 tags
// ----------------------------------------------------------------------
/** Xhtml tag for a. */
Tag A = Tag.A;
/** Xhtml tag for abbr. */
Tag ABBR = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "abbr";
}
};
/** Xhtml tag for acronym. */
Tag ACRONYM = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "acronym";
}
};
/** Xhtml tag for address. */
Tag ADDRESS = Tag.ADDRESS;
/** Xhtml tag for applet. */
Tag APPLET = Tag.APPLET;
/** Xhtml tag for area. */
Tag AREA = Tag.AREA;
/** Xhtml tag for b. */
Tag B = Tag.B;
/** Xhtml tag for base. */
Tag BASE = Tag.BASE;
/** Xhtml tag for basefont. */
Tag BASEFONT = Tag.BASEFONT;
/** Xhtml tag for bdo. */
Tag BDO = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "bdo";
}
};
/** Xhtml tag for big. */
Tag BIG = Tag.BIG;
/** Xhtml tag for blockquote. */
Tag BLOCKQUOTE = Tag.BLOCKQUOTE;
/** Xhtml tag for body. */
Tag BODY = Tag.BODY;
/** Xhtml tag for br. */
Tag BR = Tag.BR;
/** Xhtml tag for button. */
Tag BUTTON = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "button";
}
};
/** Xhtml tag for caption. */
Tag CAPTION = Tag.CAPTION;
/** Xhtml tag for center. */
Tag CENTER = Tag.CENTER;
/** Xhtml tag for cite. */
Tag CITE = Tag.CITE;
/** Xhtml tag for code. */
Tag CODE = Tag.CODE;
/** Xhtml tag for col. */
Tag COL = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "col";
}
};
/** Xhtml tag for colgroup. */
Tag COLGROUP = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "colgroup";
}
};
/** Xhtml tag for dd. */
Tag DD = Tag.DD;
/** Xhtml tag for del. */
Tag DEL = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "del";
}
};
/** Xhtml tag for dfn. */
Tag DFN = Tag.DFN;
/** Xhtml tag for dir. */
Tag DIR = Tag.DIR;
/** Xhtml tag for div. */
Tag DIV = Tag.DIV;
/** Xhtml tag for dl. */
Tag DL = Tag.DL;
/** Xhtml tag for dt. */
Tag DT = Tag.DT;
/** Xhtml tag for em. */
Tag EM = Tag.EM;
/** Xhtml tag for fieldset. */
Tag FIELDSET = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "fieldset";
}
};
/** Xhtml tag for font. */
Tag FONT = Tag.FONT;
/** Xhtml tag for form. */
Tag FORM = Tag.FORM;
/** Xhtml tag for frame. */
Tag FRAME = Tag.FRAME;
/** Xhtml tag for frameset. */
Tag FRAMESET = Tag.FRAMESET;
/** Xhtml tag for h1. */
Tag H1 = Tag.H1;
/** Xhtml tag for h2. */
Tag H2 = Tag.H2 ;
/** Xhtml tag for h3. */
Tag H3 = Tag.H3;
/** Xhtml tag for h4. */
Tag H4 = Tag.H4;
/** Xhtml tag for h5. */
Tag H5 = Tag.H5;
/** Xhtml tag for h6. */
Tag H6 = Tag.H6;
/** Xhtml tag for head. */
Tag HEAD = Tag.HEAD;
/** Xhtml tag for hr. */
Tag HR = Tag.HR;
/** Xhtml tag for html. */
Tag HTML = Tag.HTML;
/** Xhtml tag for i. */
Tag I = Tag.I;
/** Xhtml tag for iframe. */
Tag IFRAME = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "iframe";
}
};
/** Xhtml tag for img. */
Tag IMG = Tag.IMG;
/** Xhtml tag for input. */
Tag INPUT = Tag.INPUT;
/** Xhtml tag for ins. */
Tag INS = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "ins";
}
};
/** Xhtml tag for isindex. */
Tag ISINDEX = Tag.ISINDEX;
/** Xhtml tag for kbd. */
Tag KBD = Tag.KBD;
/** Xhtml tag for label. */
Tag LABEL = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "label";
}
};
/** Xhtml tag for legend. */
Tag LEGEND = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "legend";
}
};
/** Xhtml tag for li. */
Tag LI = Tag.LI;
/** Xhtml tag for link. */
Tag LINK = Tag.LINK;
/** Xhtml tag for map. */
Tag MAP = Tag.MAP;
/** Xhtml tag for menu. */
Tag MENU = Tag.MENU;
/** Xhtml tag for meta. */
Tag META = Tag.META;
/** Xhtml tag for noframes. */
Tag NOFRAMES = Tag.NOFRAMES;
/** Xhtml tag for noscript. */
Tag NOSCRIPT = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "noscript";
}
};
/** Xhtml tag for object. */
Tag OBJECT = Tag.OBJECT;
/** Xhtml tag for ol. */
Tag OL = Tag.OL;
/** Xhtml tag for optgroup. */
Tag OPTGROUP = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "optgroup";
}
};
/** Xhtml tag for option. */
Tag OPTION = Tag.OPTION;
/** Xhtml tag for p. */
Tag P = Tag.P;
/** Xhtml tag for param. */
Tag PARAM = Tag.PARAM;
/** Xhtml tag for pre. */
Tag PRE = Tag.PRE;
/** Xhtml tag for q. */
Tag Q = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "q";
}
};
/** Xhtml tag for s. */
Tag S = Tag.S;
/** Xhtml tag for samp. */
Tag SAMP = Tag.SAMP;
/** Xhtml tag for script. */
Tag SCRIPT = Tag.SCRIPT;
/** Xhtml tag for select. */
Tag SELECT = Tag.SELECT;
/** Xhtml tag for small. */
Tag SMALL = Tag.SMALL;
/** Xhtml tag for span. */
Tag SPAN = Tag.SPAN;
/** Xhtml tag for strike. */
Tag STRIKE = Tag.STRIKE;
/** Xhtml tag for strong. */
Tag STRONG = Tag.STRONG;
/** Xhtml tag for style. */
Tag STYLE = Tag.STYLE;
/** Xhtml tag for sub. */
Tag SUB = Tag.SUB;
/** Xhtml tag for sup. */
Tag SUP = Tag.SUP;
/** Xhtml tag for table. */
Tag TABLE = Tag.TABLE;
/** Xhtml tag for tbody. */
Tag TBODY = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "tbody";
}
};
/** Xhtml tag for td. */
Tag TD = Tag.TD;
/** Xhtml tag for textarea. */
Tag TEXTAREA = Tag.TEXTAREA;
/** Xhtml tag for tfoot. */
Tag TFOOT = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "tfoot";
}
};
/** Xhtml tag for th. */
Tag TH = Tag.TH;
/** Xhtml tag for thead. */
Tag THEAD = new Tag()
{
/** {@inheritDoc} */
public String toString()
{
return "thead";
}
};
/** Xhtml tag for title. */
Tag TITLE = Tag.TITLE;
/** Xhtml tag for tr. */
Tag TR = Tag.TR;
/** Xhtml tag for tt. */
Tag TT = Tag.TT;
/** Xhtml tag for u. */
Tag U = Tag.U;
/** Xhtml tag for ul. */
Tag UL = Tag.UL;
/** Xhtml tag for var. */
Tag VAR = Tag.VAR ;
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/markup/XmlMarkup.java 0000644 0001750 0001750 00000003616 11216135717 027563 0 ustar twerner twerner package org.apache.maven.doxia.markup;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* List of constants used by Xml markup syntax.
*
* @author Vincent Siveton
* @version $Id: XmlMarkup.java 785531 2009-06-17 09:47:59Z ltheussl $
* @since 1.0
*/
public interface XmlMarkup
extends Markup
{
/** XML namespace: "http://www.w3.org/2001/XMLSchema-instance" */
String XML_NAMESPACE = "http://www.w3.org/2001/XMLSchema-instance";
// ----------------------------------------------------------------------
// Xml separator characters
// ----------------------------------------------------------------------
/** bang character: '!' */
char BANG = '!';
// ----------------------------------------------------------------------
// Xml constants
// ----------------------------------------------------------------------
/** CDATA. String: "CDATA". */
String CDATA = "CDATA";
/** DOCTYPE start. String: "<!DOCTYPE". */
String DOCTYPE_START = "newReader methods from {@link org.codehaus.plexus.util.ReaderFactory}.
* @param parserId Identifier for the parser to use.
* @param sink A sink that consumes the Doxia events.
* @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
* if no parser could be found for the given id.
* @throws org.apache.maven.doxia.parser.ParseException if the model could not be parsed.
*/
void parse( Reader source, String parserId, Sink sink )
throws ParserNotFoundException, ParseException;
/**
* Return a parser for the given parserId.
*
* @param parserId Identifier for the parser to use.
* @return the parser defining by parserId.
* @throws org.apache.maven.doxia.parser.manager.ParserNotFoundException
* if no parser could be found for the given id.
*/
Parser getParser( String parserId )
throws ParserNotFoundException;
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/sink/ 0000755 0001750 0001750 00000000000 11632765553 024450 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/sink/SinkEventAttributeSet.java 0000644 0001750 0001750 00000025770 11163510073 031554 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Collections;
import java.util.Enumeration;
import java.util.LinkedHashMap;
import java.util.Map;
import javax.swing.text.AttributeSet;
/**
* Implementation of MutableAttributeSet using a LinkedHashMap.
*
* @author ltheussl
* @version $Id: SinkEventAttributeSet.java 759587 2009-03-28 21:01:47Z ltheussl $
* @since 1.1
*/
public class SinkEventAttributeSet
implements SinkEventAttributes, Cloneable
{
/**
* An unmodifiable attribute set containing only an underline attribute.
*/
public static final SinkEventAttributes UNDERLINE;
/**
* An unmodifiable attribute set containing only an overline attribute.
*/
public static final SinkEventAttributes OVERLINE;
/**
* An unmodifiable attribute set containing only a linethrough attribute.
*/
public static final SinkEventAttributes LINETHROUGH;
/**
* An unmodifiable attribute set containing only a boxed attribute.
*/
public static final SinkEventAttributes BOXED;
/**
* An unmodifiable attribute set containing only a bold attribute.
*/
public static final SinkEventAttributes BOLD;
/**
* An unmodifiable attribute set containing only an italic attribute.
*/
public static final SinkEventAttributes ITALIC;
/**
* An unmodifiable attribute set containing only a monospaced attribute.
*/
public static final SinkEventAttributes MONOSPACED;
/**
* An unmodifiable attribute set containing only a left attribute.
*/
public static final SinkEventAttributes LEFT;
/**
* An unmodifiable attribute set containing only a right attribute.
*/
public static final SinkEventAttributes RIGHT;
/**
* An unmodifiable attribute set containing only a center attribute.
*/
public static final SinkEventAttributes CENTER;
/**
* An unmodifiable attribute set containing only a justify attribute.
*/
public static final SinkEventAttributes JUSTIFY;
static
{
UNDERLINE = new SinkEventAttributeSet( new String[] {DECORATION, "underline"} ).unmodifiable();
OVERLINE = new SinkEventAttributeSet( new String[] {DECORATION, "overline"} ).unmodifiable();
LINETHROUGH = new SinkEventAttributeSet( new String[] {DECORATION, "line-through"} ).unmodifiable();
BOXED = new SinkEventAttributeSet( new String[] {DECORATION, "boxed"} ).unmodifiable();
BOLD = new SinkEventAttributeSet( new String[] {STYLE, "bold"} ).unmodifiable();
ITALIC = new SinkEventAttributeSet( new String[] {STYLE, "italic"} ).unmodifiable();
MONOSPACED = new SinkEventAttributeSet( new String[] {STYLE, "monospaced"} ).unmodifiable();
LEFT = new SinkEventAttributeSet( new String[] {ALIGN, "left"} ).unmodifiable();
RIGHT = new SinkEventAttributeSet( new String[] {ALIGN, "right"} ).unmodifiable();
CENTER = new SinkEventAttributeSet( new String[] {ALIGN, "center"} ).unmodifiable();
JUSTIFY = new SinkEventAttributeSet( new String[] {ALIGN, "justify"} ).unmodifiable();
}
private Map attribs;
private AttributeSet resolveParent;
/**
* Constructs a new, empty SinkEventAttributeSet with default size 5.
*/
public SinkEventAttributeSet()
{
this( 5 );
}
/**
* Constructs a new, empty SinkEventAttributeSet with the specified initial size.
*
* @param size the initial number of attribs.
*/
public SinkEventAttributeSet( int size )
{
attribs = new LinkedHashMap( size );
}
/**
* Constructs a new SinkEventAttributeSet with the attribute name-value
* mappings as given by the specified String array.
*
* @param attributes the specified String array. If the length of this array
* is not an even number, an IllegalArgumentException is thrown.
*/
public SinkEventAttributeSet( String[] attributes )
{
int n = attributes.length;
if ( ( n % 2 ) != 0 )
{
throw new IllegalArgumentException( "Missing attribute!" );
}
attribs = new LinkedHashMap( n / 2 );
for ( int i = 0; i < n; i = i + 2 )
{
attribs.put( attributes[i], attributes[i + 1] );
}
}
/**
* Constructs a new SinkEventAttributeSet with the same attribute name-value
* mappings as in the specified AttributeSet.
*
* @param attributes the specified AttributeSet.
*/
public SinkEventAttributeSet( AttributeSet attributes )
{
attribs = new LinkedHashMap( attributes.getAttributeCount() );
Enumeration names = attributes.getAttributeNames();
while ( names.hasMoreElements() )
{
Object name = names.nextElement();
attribs.put( name, attributes.getAttribute( name ) );
}
}
/**
* Replace this AttributeSet by an unmodifiable view of itself.
* Any subsequent attempt to add, remove or modify the underlying mapping
* will result in an UnsupportedOperationException.
*
* @return an unmodifiable view of this AttributeSet.
*
* @since 1.1.1
*/
public SinkEventAttributeSet unmodifiable()
{
this.attribs = Collections.unmodifiableMap( attribs );
return this;
}
/**
* Checks whether the set of attribs is empty.
*
* @return true if the set is empty.
*/
public boolean isEmpty()
{
return attribs.isEmpty();
}
/** {@inheritDoc} */
public int getAttributeCount()
{
return attribs.size();
}
/** {@inheritDoc} */
public boolean isDefined( Object attrName )
{
return attribs.containsKey( attrName );
}
/** {@inheritDoc} */
public boolean isEqual( AttributeSet attr )
{
return ( ( getAttributeCount() == attr.getAttributeCount() )
&& containsAttributes( attr ) );
}
/** {@inheritDoc} */
public AttributeSet copyAttributes()
{
return ( (AttributeSet) clone() );
}
/** {@inheritDoc} */
public Enumeration getAttributeNames()
{
return Collections.enumeration( attribs.keySet() );
}
/** {@inheritDoc} */
public Object getAttribute( Object key )
{
Object value = attribs.get( key );
if ( value == null )
{
AttributeSet parent = getResolveParent();
if ( parent != null )
{
value = parent.getAttribute( key );
}
}
return value;
}
/** {@inheritDoc} */
public boolean containsAttribute( Object name, Object value )
{
return value.equals( getAttribute( name ) );
}
/** {@inheritDoc} */
public boolean containsAttributes( AttributeSet attributes )
{
boolean result = true;
Enumeration names = attributes.getAttributeNames();
while ( result && names.hasMoreElements() )
{
Object name = names.nextElement();
result = attributes.getAttribute( name ).equals( getAttribute( name ) );
}
return result;
}
/**
* {@inheritDoc}
*
* Adds an attribute with the given name and value.
*/
public void addAttribute( Object name, Object value )
{
attribs.put( name.toString(), value );
}
/** {@inheritDoc} */
public void addAttributes( AttributeSet attributes )
{
if ( attributes == null || attributes.getAttributeCount() == 0 )
{
return;
}
Enumeration names = attributes.getAttributeNames();
while ( names.hasMoreElements() )
{
Object name = names.nextElement();
addAttribute( name, attributes.getAttribute( name ) );
}
}
/** {@inheritDoc} */
public void removeAttribute( Object name )
{
attribs.remove( name );
}
/** {@inheritDoc} */
public void removeAttributes( Enumeration names )
{
while ( names.hasMoreElements() )
{
removeAttribute( names.nextElement() );
}
}
/** {@inheritDoc} */
public void removeAttributes( AttributeSet attributes )
{
if ( attributes == null )
{
return;
}
else if ( attributes == this )
{
attribs.clear();
}
else
{
Enumeration names = attributes.getAttributeNames();
while ( names.hasMoreElements() )
{
Object name = names.nextElement();
Object value = attributes.getAttribute( name );
if ( value.equals( getAttribute( name ) ) )
{
removeAttribute( name );
}
}
}
}
/** {@inheritDoc} */
public AttributeSet getResolveParent()
{
return this.resolveParent;
}
/** {@inheritDoc} */
public void setResolveParent( AttributeSet parent )
{
this.resolveParent = parent;
}
/** {@inheritDoc} */
public Object clone()
{
SinkEventAttributeSet attr = new SinkEventAttributeSet( attribs.size() );
attr.attribs = new LinkedHashMap( attribs );
if ( resolveParent != null )
{
attr.resolveParent = resolveParent.copyAttributes();
}
return attr;
}
/** {@inheritDoc} */
public int hashCode()
{
final int parentHash = ( resolveParent == null ? 0 : resolveParent.hashCode() );
return attribs.hashCode() + parentHash;
}
/** {@inheritDoc} */
public boolean equals( Object obj )
{
if ( this == obj )
{
return true;
}
if ( obj instanceof SinkEventAttributeSet )
{
return isEqual( (SinkEventAttributeSet) obj );
}
return false;
}
/** {@inheritDoc} */
public String toString()
{
StringBuffer s = new StringBuffer();
Enumeration names = getAttributeNames();
while ( names.hasMoreElements() )
{
String key = names.nextElement().toString();
String value = getAttribute( key ).toString();
s.append( ' ' ).append( key ).append( '=' ).append( value );
}
return s.toString();
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/sink/AbstractXmlSink.java 0000644 0001750 0001750 00000012254 11166632332 030356 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.markup.XmlMarkup;
/**
* An abstract Sink for xml markup syntax.
*
* @author Vincent Siveton
* @version $Id: AbstractXmlSink.java 762690 2009-04-07 11:11:22Z ltheussl $
* @since 1.0
*/
public abstract class AbstractXmlSink
extends SinkAdapter
implements XmlMarkup
{
/** Default namespace prepended to all tags */
private String nameSpace;
/**
* Sets the default namespace that is prepended to all tags written by this sink.
*
* @param ns the default namespace.
* @since 1.1
*/
public void setNameSpace( String ns )
{
this.nameSpace = ns;
}
/**
* Return the default namespace that is prepended to all tags written by this sink.
*
* @return the current default namespace.
* @since 1.1
*/
public String getNameSpace()
{
return this.nameSpace;
}
/**
* Starts a Tag. For instance:
*
* <tag>
*
*
* @param t a non null tag
* @see #writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet)
*/
protected void writeStartTag( Tag t )
{
writeStartTag ( t, null );
}
/**
* Starts a Tag with attributes. For instance:
*
* <tag attName="attValue">
*
*
* @param t a non null tag.
* @param att a set of attributes. May be null.
* @see #writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet, boolean).
*/
protected void writeStartTag( Tag t, MutableAttributeSet att )
{
writeStartTag ( t, att, false );
}
/**
* Starts a Tag with attributes. For instance:
*
* <tag attName="attValue">
*
*
* @param t a non null tag.
* @param att a set of attributes. May be null.
* @param isSimpleTag boolean to write as a simple tag.
*/
protected void writeStartTag( Tag t, MutableAttributeSet att, boolean isSimpleTag )
{
if ( t == null )
{
throw new IllegalArgumentException( "A tag is required" );
}
StringBuffer sb = new StringBuffer();
sb.append( LESS_THAN );
if ( nameSpace != null )
{
sb.append( nameSpace ).append( ':' );
}
sb.append( t.toString() );
sb.append( SinkUtils.getAttributeString( att ) );
if ( isSimpleTag )
{
sb.append( SPACE ).append( SLASH );
}
sb.append( GREATER_THAN );
write( sb.toString() );
}
/**
* Writes a system EOL.
*
* @since 1.1
*/
protected void writeEOL()
{
write( EOL );
}
/**
* Ends a Tag without writing an EOL. For instance:
</tag>
.
*
* @param t a tag.
*/
protected void writeEndTag( Tag t )
{
if ( t == null )
{
throw new IllegalArgumentException( "A tag is required" );
}
StringBuffer sb = new StringBuffer();
sb.append( LESS_THAN );
sb.append( SLASH );
if ( nameSpace != null )
{
sb.append( nameSpace ).append( ':' );
}
sb.append( t.toString() );
sb.append( GREATER_THAN );
write( sb.toString() );
}
/**
* Starts a simple Tag. For instance:
*
* <tag />
*
*
* @param t a non null tag
* @see #writeSimpleTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet)
*/
protected void writeSimpleTag( Tag t )
{
writeSimpleTag( t, null );
}
/**
* Starts a simple Tag with attributes. For instance:
*
* <tag attName="attValue" />
*
*
* @param t a non null tag.
* @param att a set of attributes. May be null.
* @see #writeStartTag(javax.swing.text.html.HTML.Tag, javax.swing.text.MutableAttributeSet, boolean).
*/
protected void writeSimpleTag( Tag t, MutableAttributeSet att )
{
writeStartTag ( t, att, true );
}
/**
* Write a text to the sink.
*
* @param text the given text to write
*/
protected abstract void write( String text );
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/sink/XhtmlBaseSink.java 0000644 0001750 0001750 00000153231 11351662460 030023 0 ustar twerner twerner package org.apache.maven.doxia.sink;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.io.PrintWriter;
import java.io.StringWriter;
import java.io.Writer;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedList;
import java.util.Map;
import java.util.Set;
import java.util.TreeSet;
import javax.swing.text.MutableAttributeSet;
import javax.swing.text.html.HTML.Attribute;
import javax.swing.text.html.HTML.Tag;
import org.apache.maven.doxia.markup.HtmlMarkup;
import org.apache.maven.doxia.markup.Markup;
import org.apache.maven.doxia.util.DoxiaUtils;
import org.apache.maven.doxia.util.HtmlTools;
import org.codehaus.plexus.util.StringUtils;
import org.codehaus.plexus.util.xml.PrettyPrintXMLWriter;
/**
* Abstract base xhtml sink implementation.
*
* @author Jason van Zyl
* @author ltheussl
* @version $Id: XhtmlBaseSink.java 926049 2010-03-22 12:40:16Z ltheussl $
* @since 1.1
*/
public class XhtmlBaseSink
extends AbstractXmlSink
implements HtmlMarkup
{
// ----------------------------------------------------------------------
// Instance fields
// ----------------------------------------------------------------------
/** The PrintWriter to write the result. */
private final PrintWriter writer;
/** Used to collect text events mainly for the head events. */
private StringBuffer textBuffer = new StringBuffer();
/** An indication on if we're inside a head. */
private boolean headFlag;
/** An indication on if we're inside an image caption flag. */
private boolean figureCaptionFlag;
/** An indication on if we're inside a paragraph flag. */
private boolean paragraphFlag;
/** An indication on if we're in verbatim mode. */
private boolean verbatimFlag;
/** Stack of alignment int[] of table cells. */
private final LinkedList cellJustifStack;
/** Stack of justification of table cells. */
private final LinkedList isCellJustifStack;
/** Stack of current table cell. */
private final LinkedList cellCountStack;
/** Used to style successive table rows differently. */
private boolean evenTableRow = true;
/** The stack of StringWriter to write the table result temporary, so we could play with the output DOXIA-177. */
private final LinkedList tableContentWriterStack;
private final LinkedList tableCaptionWriterStack;
private final LinkedList tableCaptionXMLWriterStack;
/** The stack of table caption */
private final LinkedList tableCaptionStack;
/** used to store attributes passed to table(). */
protected MutableAttributeSet tableAttributes;
/** Used to distinguish old-style figure handling. */
private boolean legacyFigure;
/** Used to distinguish old-style figure handling. */
private boolean legacyFigureCaption;
/** Indicates that an image is part of a figure. */
private boolean inFigure;
/** Flag to know if {@link #tableRows(int[], boolean)} is called or not. It is mainly to be backward compatible
* with some plugins (like checkstyle) which uses:
*
* */
protected boolean tableRows = false;
/** Map of warn messages with a String as key to describe the error type and a Set as value.
* Using to reduce warn messages. */
private Map warnMessages;
// ----------------------------------------------------------------------
// Constructor
// ----------------------------------------------------------------------
/**
* Constructor, initialize the PrintWriter.
*
* @param out The writer to write the result.
*/
public XhtmlBaseSink( Writer out )
{
this.writer = new PrintWriter( out );
this.cellJustifStack = new LinkedList();
this.isCellJustifStack = new LinkedList();
this.cellCountStack = new LinkedList();
this.tableContentWriterStack = new LinkedList();
this.tableCaptionWriterStack = new LinkedList();
this.tableCaptionXMLWriterStack = new LinkedList();
this.tableCaptionStack = new LinkedList();
init();
}
// ----------------------------------------------------------------------
// Accessor methods
// ----------------------------------------------------------------------
/**
* To use mainly when playing with the head events.
*
* @return the current buffer of text events.
*/
protected StringBuffer getTextBuffer()
{
return this.textBuffer;
}
/**
*
*
* @param basedir a {@link java.io.File} object.
* @param document a {@link java.lang.String} object.
* @param parserId a {@link java.lang.String} object.
* @param extension a {@link java.lang.String} object.
*/
public RenderingContext( File basedir, String document, String parserId, String extension )
{
this.basedir = basedir;
this.extension = extension;
if ( StringUtils.isNotEmpty( extension ) )
{
// here we now the parserId we can play with this
// index.xml -> index.html
// index.xml.vm -> index.html
// download.apt.vm --> download.html
int startIndexOfExtension =
document.toLowerCase( Locale.ENGLISH ).indexOf( "." + extension.toLowerCase( Locale.ENGLISH ) );
String fileNameWithoutExt = document.substring( 0, startIndexOfExtension );
this.outputName = fileNameWithoutExt + ".html";
}
else
{
this.outputName = document.substring( 0, document.indexOf( "." ) ).replace( '\\', '/' ) + ".html";
}
this.relativePath = PathTool.getRelativePath( basedir.getPath(), new File( basedir, document ).getPath() );
this.inputName = document;
this.parserId = parserId;
this.attributes = new HashMap();
}
/**
*
Getter for the field basedir.
*
* @return a {@link java.io.File} object.
*/
public File getBasedir()
{
return basedir;
}
/**
*
Getter for the field inputName.
*
* @return a {@link java.lang.String} object.
*/
public String getInputName()
{
return inputName;
}
/**
*
Getter for the field outputName.
*
* @return a {@link java.lang.String} object.
*/
public String getOutputName()
{
return outputName;
}
/**
*
Getter for the field parserId.
*
* @return a {@link java.lang.String} object.
*/
public String getParserId()
{
return parserId;
}
/**
*
Getter for the field relativePath.
*
* @return a {@link java.lang.String} object.
*/
public String getRelativePath()
{
return relativePath;
}
/**
*
setAttribute.
*
* @param key a {@link java.lang.String} object.
* @param value a {@link java.lang.String} object.
*/
public void setAttribute( String key, String value )
{
attributes.put( key, value );
}
/**
*
getAttribute.
*
* @param key a {@link java.lang.String} object.
* @return a {@link java.lang.String} object.
*/
public String getAttribute( String key )
{
return (String) attributes.get( key );
}
/**
*
Getter for the field extension.
*
* @return a {@link java.lang.String} object.
*/
public String getExtension()
{
return extension;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/index/ 0000755 0001750 0001750 00000000000 11632765554 024614 5 ustar twerner twerner doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexingSink.java 0000644 0001750 0001750 00000015274 11245330530 030040 0 ustar twerner twerner package org.apache.maven.doxia.index;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.Stack;
import org.apache.maven.doxia.util.HtmlTools;
import org.apache.maven.doxia.sink.SinkAdapter;
/**
* A sink implementation for index.
*
* @author Trygve Laugstøl
* @author Vincent Siveton
* @version $Id: IndexingSink.java 808200 2009-08-26 22:04:08Z vsiveton $
*/
public class IndexingSink
extends SinkAdapter
{
/** Section 1. */
private static final int TYPE_SECTION_1 = 1;
/** Section 2. */
private static final int TYPE_SECTION_2 = 2;
/** Section 3. */
private static final int TYPE_SECTION_3 = 3;
/** Section 4. */
private static final int TYPE_SECTION_4 = 4;
/** Section 5. */
private static final int TYPE_SECTION_5 = 5;
/** Defined term. */
private static final int TYPE_DEFINED_TERM = 6;
/** Figure. */
private static final int TYPE_FIGURE = 7;
/** Table. */
private static final int TYPE_TABLE = 8;
/** Title. */
private static final int TITLE = 9;
/** The current type. */
private int type;
/** The current title. */
private String title;
/** The stack. */
private final Stack stack;
/** The current type. */
private IndexEntry currentEntry;
/**
* Default constructor.
*
* @param sectionEntry The first index entry.
*/
public IndexingSink( IndexEntry sectionEntry )
{
stack = new Stack();
stack.push( sectionEntry );
init();
}
/**
*
Getter for the field title.
*
* @return the title
*/
public String getTitle()
{
return title;
}
// ----------------------------------------------------------------------
// Sink Overrides
// ----------------------------------------------------------------------
/** {@inheritDoc} */
public void title()
{
this.type = TITLE;
}
/** {@inheritDoc} */
public void sectionTitle1()
{
this.currentEntry = null;
this.type = TYPE_SECTION_1;
}
/** {@inheritDoc} */
public void title_()
{
this.type = 0;
}
public void sectionTitle1_()
{
this.type = 0;
}
/** {@inheritDoc} */
public void section1_()
{
pop();
}
/** {@inheritDoc} */
public void sectionTitle2()
{
this.currentEntry = null;
this.type = TYPE_SECTION_2;
}
public void sectionTitle2_()
{
this.type = 0;
}
/** {@inheritDoc} */
public void section2_()
{
pop();
}
/** {@inheritDoc} */
public void sectionTitle3()
{
this.currentEntry = null;
this.type = TYPE_SECTION_3;
}
public void sectionTitle3_()
{
this.type = 0;
}
/** {@inheritDoc} */
public void section3_()
{
pop();
}
/** {@inheritDoc} */
public void sectionTitle4()
{
this.currentEntry = null;
this.type = TYPE_SECTION_4;
}
public void sectionTitle4_()
{
this.type = 0;
}
/** {@inheritDoc} */
public void section4_()
{
pop();
}
/** {@inheritDoc} */
public void sectionTitle5()
{
this.currentEntry = null;
this.type = TYPE_SECTION_5;
}
public void sectionTitle5_()
{
this.type = 0;
}
/** {@inheritDoc} */
public void section5_()
{
pop();
}
// public void definedTerm()
// {
// type = TYPE_DEFINED_TERM;
// }
//
// public void figureCaption()
// {
// type = TYPE_FIGURE;
// }
//
// public void tableCaption()
// {
// type = TYPE_TABLE;
// }
/** {@inheritDoc} */
public void text( String text )
{
switch ( this.type )
{
case TITLE:
this.title = text;
break;
case TYPE_SECTION_1:
case TYPE_SECTION_2:
case TYPE_SECTION_3:
case TYPE_SECTION_4:
case TYPE_SECTION_5:
// -----------------------------------------------------------------------
// Sanitize the id. The most important step is to remove any blanks
// -----------------------------------------------------------------------
if ( this.currentEntry == null )
{
this.currentEntry = new IndexEntry( peek(), HtmlTools.encodeId( text ) );
this.currentEntry.setTitle( text );
push( currentEntry );
}
else
{
IndexEntry entry = (IndexEntry) stack.lastElement();
String title = currentEntry.getTitle() + text;
title = title.replaceAll( "[\\r\\n]+", "" );
entry.setId( HtmlTools.encodeId( title ) );
entry.setTitle( title );
}
break;
// Dunno how to handle these yet
case TYPE_DEFINED_TERM:
case TYPE_FIGURE:
case TYPE_TABLE:
default:
break;
}
}
/**
* Pushes an IndexEntry onto the top of this stack.
*
* @param entry to put.
*/
public void push( IndexEntry entry )
{
stack.push( entry );
}
/**
* Removes the IndexEntry at the top of this stack.
*/
public void pop()
{
stack.pop();
}
/**
*
peek.
*
* @return Looks at the IndexEntry at the top of this stack.
*/
public IndexEntry peek()
{
return (IndexEntry) stack.peek();
}
/** {@inheritDoc} */
public void close()
{
super.close();
init();
}
/** {@inheritDoc} */
protected void init()
{
this.type = 0;
this.title = null;
}
}
doxia-1.1.4/doxia-core/src/main/java/org/apache/maven/doxia/index/IndexEntry.java 0000644 0001750 0001750 00000015367 11244765230 027552 0 ustar twerner twerner package org.apache.maven.doxia.index;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
import java.util.ArrayList;
import java.util.Iterator;
import java.util.Collections;
import org.codehaus.plexus.util.StringUtils;
/**
*
IndexEntry class.
*
* @author Trygve Laugstøl
* @version $Id: IndexEntry.java 807625 2009-08-25 13:43:52Z vsiveton $
*/
public class IndexEntry
{
/** The parent entry. */
private final IndexEntry parent;
/** The id of the entry. */
private String id;
/** The entry title. */
private String title;
/** The child entries. */
private List childEntries = new ArrayList();
/** System-dependent EOL. */
private static final String EOL = System.getProperty( "line.separator" );
/**
* Constructor.
*
* @param newId The id. May be null.
*/
public IndexEntry( String newId )
{
this( null, newId );
}
/**
* Constructor.
*
* @param newParent The parent. May be null.
* @param newId The id. May be null.
*/
public IndexEntry( IndexEntry newParent, String newId )
{
this.parent = newParent;
this.id = newId;
if ( parent != null )
{
parent.childEntries.add( this );
}
}
/**
* Returns the parent entry.
*
* @return the parent entry.
*/
public IndexEntry getParent()
{
return parent;
}
/**
* Returns the id.
*
* @return the id.
*/
public String getId()
{
return id;
}
/**
* Set the id.
*
* @since 1.1.2
*/
protected void setId( String id )
{
this.id = id;
}
/**
* Returns the title.
*
* @return the title.
*/
public String getTitle()
{
return title;
}
/**
* Sets the title.
*
* @param newTitle the title.
*/
public void setTitle( String newTitle )
{
this.title = newTitle;
}
/**
* Returns an unmodifiableList of the child entries.
*
* @return child entries.
*/
public List getChildEntries()
{
return Collections.unmodifiableList( childEntries );
}
/**
* Sets the child entries or creates a new ArrayList if entries == null.
*
* @param entries the entries.
*/
public void setChildEntries( List entries )
{
if ( entries == null )
{
childEntries = new ArrayList();
}
this.childEntries = entries;
}
// -----------------------------------------------------------------------
// Utils
// -----------------------------------------------------------------------
/**
* Returns the next entry.
*
* @return the next entry, or null if there is none.
*/
public IndexEntry getNextEntry()
{
if ( parent == null )
{
return null;
}
List entries = parent.getChildEntries();
int index = entries.indexOf( this );
if ( index + 1 >= entries.size() )
{
return null;
}
return (IndexEntry) entries.get( index + 1 );
}
/**
* Returns the previous entry.
*
* @return the previous entry, or null if there is none.
*/
public IndexEntry getPrevEntry()
{
if ( parent == null )
{
return null;
}
List entries = parent.getChildEntries();
int index = entries.indexOf( this );
if ( index == 0 )
{
return null;
}
return (IndexEntry) entries.get( index - 1 );
}
/**
* Returns the first entry.
*
* @return the first entry, or null if there is none.
*/
public IndexEntry getFirstEntry()
{
List entries = getChildEntries();
if ( entries.size() == 0 )
{
return null;
}
return (IndexEntry) entries.get( 0 );
}
/**
* Returns the last entry.
*
* @return the last entry, or null if there is none.
*/
public IndexEntry getLastEntry()
{
List entries = getChildEntries();
if ( entries.size() == 0 )
{
return null;
}
return (IndexEntry) entries.get( entries.size() - 1 );
}
/**
* Returns the root entry.
*
* @return the root entry, or null if there is none.
*/
public IndexEntry getRootEntry()
{
List entries = getChildEntries();
if ( entries.size() == 0 )
{
return null;
}
else if ( entries.size() > 1 )
{
throw new RuntimeException( "This index has more than one root entry" );
}
else
{
return (IndexEntry) entries.get( 0 );
}
}
// -----------------------------------------------------------------------
// Object Overrides
// -----------------------------------------------------------------------
/**
* {@inheritDoc}
*
* Returns a string representation of the object.
*/
public String toString()
{
return toString( 0 );
}
/**
* Returns a string representation of all objects to the given depth.
*
* @param depth The depth to descent to.
* @return A string.
*/
public String toString( int depth )
{
StringBuffer message = new StringBuffer();
message.append( "Id: " ).append( id );
if ( StringUtils.isNotEmpty( title ) )
{
message.append( ", title: " ).append( title );
}
message.append( EOL );
String indent = "";
for ( int i = 0; i < depth; i++ )
{
indent += " ";
}
for ( Iterator it = getChildEntries().iterator(); it.hasNext(); )
{
IndexEntry entry = (IndexEntry) it.next();
message.append( indent ).append( entry.toString( depth + 1 ) );
}
return message.toString();
}
}
doxia-1.1.4/doxia-maven-plugin/ 0000755 0001750 0001750 00000000000 11632765550 016275 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/pom.xml 0000644 0001750 0001750 00000014713 11470562366 017620 0 ustar twerner twerner
4.0.0org.apache.maven.doxiadoxia1.1.4../pom.xmldoxia-maven-pluginmaven-pluginDoxia :: Maven PluginA Maven plugin for Doxia.2.0.2org.apache.mavenmaven-plugin-api2.0${project.groupId}doxia-book${projectVersion}${project.groupId}doxia-core${projectVersion}${project.groupId}doxia-logging-api${projectVersion}org.apache.maven.doxiadoxia-module-apt${projectVersion}org.apache.maven.doxiadoxia-module-docbook-simple${projectVersion}org.apache.maven.doxiadoxia-module-itext${projectVersion}org.apache.maven.doxiadoxia-module-latex${projectVersion}org.apache.maven.doxiadoxia-module-xdoc${projectVersion}org.apache.maven.doxiadoxia-module-xhtml${projectVersion}org.apache.maven.doxiadoxia-decoration-model1.1.2org.codehaus.plexusplexus-utilsorg.apache.maven.sharedmaven-doxia-tools1.0.1org.apache.maven.doxiadoxia-decoration-modelorg.apache.maven.pluginsmaven-plugin-plugin2.5.1org.apache.maven.pluginsmaven-shade-plugin1.2.2org.apache.maven.pluginsmaven-shade-pluginpackageshade${project.build.finalName}falsetrueorg.apache.maven.doxia:doxia-sink-apiorg.apache.maven.doxia:doxia-logging-apiorg.codehaus.mojoclirr-maven-plugin1.1org/apache/maven/doxia/logging/**org/apache/maven/doxia/sink/**org/codehaus/doxia/sink/**org.apache.maven.pluginsmaven-plugin-plugingenerated-helpmojohelpmojoorg.apache.maven.pluginsmaven-plugin-plugin2.5.1
doxia-1.1.4/doxia-maven-plugin/src/ 0000755 0001750 0001750 00000000000 11632765550 017064 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/site/ 0000755 0001750 0001750 00000000000 11632765550 020030 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/site/apt/ 0000755 0001750 0001750 00000000000 11632765550 020614 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/site/apt/usage.apt.vm 0000644 0001750 0001750 00000002467 11237300613 023042 0 ustar twerner twerner -----
Usage
-----
Lukas Theussl
-----
Usage
Below is a sample pom.xml illustrate how to use it.
+------------------------------------------------------
org.apache.maven.doxiadoxia-maven-plugin${project.version}pre-siterender-bookssrc/books/example-booksrc/books/example-book.xmllatexxdocpdfrtf
+------------------------------------------------------
See also the sample given on the main Doxia {{{http://maven.apache.org/doxia/book/index.html}site}}.
doxia-1.1.4/doxia-maven-plugin/src/site/apt/index.apt 0000644 0001750 0001750 00000006471 11237301120 022415 0 ustar twerner twerner -----
Doxia Maven Plugin
-----
Lukas Theussl
-----
~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements. See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership. The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied. See the License for the
~~ specific language governing permissions and limitations
~~ under the License.
~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html
Introduction
Doxia allows you to write books like user manuals and guides in any format supported by Doxia. Combined with the
Doxia Book Maven you are able to include the manuals directly in your generated site with links to the off-line
friendly formats like XDoc, PDF, RTF and LaTeX.
* Goals Overview
The Doxia Maven Plugin has one goal:
* {{{./render-books-mojo.html}doxia:render-books}} to create books in different output formats.
First you need a simple book descriptor which is used to specify the layout of your book, i.e.
the ordering of the sections and the names for the chapters.
See {{{http://maven.apache.org/doxia/book/index.html}The Book Descriptor Reference}}
for a reference to the descriptor.
* Usage
General instructions on how to use the Doxia Maven Plugin can be found on the {{{./usage.html}usage page}}. Some more
specific use cases are described in the examples given below. Last but not least, users occasionally contribute
additional examples, tips or errata to the
{{{http://docs.codehaus.org/display/MAVENUSER/PDF+Plugin}plugin's wiki page}}.
In case you still have questions regarding the plugin's usage, please have a look at the {{{./faq.html}FAQ}} and feel
free to contact the {{{./mail-lists.html}user mailing list}}. The posts to the mailing list are archived and could
already contain the answer to your question as part of an older thread. Hence, it is also worth browsing/searching
the {{{./mail-lists.html}mail archive}}.
If you feel like the plugin is missing a feature or has a defect, you can fill a feature request or bug report in our
{{{./issue-tracking.html}issue tracker}}. When creating a new issue, please provide a comprehensive description of your
concern. Especially for fixing bugs it is crucial that the developers can reproduce your problem. For this reason,
entire debug logs, POMs or most preferably little demo projects attached to the issue are very much appreciated.
Of course, patches are welcome, too. Contributors can check out the project from our
{{{./source-repository.html}source repository}} and will find supplementary information in the
{{{http://maven.apache.org/guides/development/guide-helping.html}guide to helping with Maven}}.
* Examples
An Xdoc output example which has been rendered into this site can be viewed {{{http://maven.apache.org/doxia/doxia-example-book/index.html}here}}.
doxia-1.1.4/doxia-maven-plugin/src/site/site.xml 0000644 0001750 0001750 00000002635 11237301120 021500 0 ustar twerner twerner
doxia-1.1.4/doxia-maven-plugin/src/main/ 0000755 0001750 0001750 00000000000 11632765550 020010 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/ 0000755 0001750 0001750 00000000000 11632765550 020731 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/org/ 0000755 0001750 0001750 00000000000 11632765550 021520 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/ 0000755 0001750 0001750 00000000000 11632765550 022741 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/ 0000755 0001750 0001750 00000000000 11632765550 024047 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/ 0000755 0001750 0001750 00000000000 11632765550 025153 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/ 0000755 0001750 0001750 00000000000 11632765550 026451 5 ustar twerner twerner doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Format.java 0000644 0001750 0001750 00000002462 11142164566 030544 0 ustar twerner twerner package org.apache.maven.doxia.plugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
/**
* A model for a supported output format.
*
* @author Trygve Laugstøl
* @version $Id: Format.java 740545 2009-02-04 01:03:50Z vsiveton $
* @since 1.0
*/
public class Format
{
/** A unique identifier for the format. */
private String id;
/**
* Returns the (unique) identifier of this format.
*
* @return the identifier.
*/
public String getId()
{
return id;
}
}
doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/Book.java 0000644 0001750 0001750 00000004435 11142164566 030210 0 ustar twerner twerner package org.apache.maven.doxia.plugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import java.util.List;
/**
* A model for a Book.
*
* @author Trygve Laugstøl
* @version $Id: Book.java 740545 2009-02-04 01:03:50Z vsiveton $
* @since 1.0
*/
public class Book
{
/** Path to the book descriptor file. */
private String descriptor;
/** The list of formats to produce. */
private List formats;
/** The base directory of source files. */
private String directory;
/** Files to include. */
private List includes;
/** Files to exclude. */
private List excludes;
/**
* Returns the path to the book descriptor file.
*
* @return the book descriptor file.
*/
public String getDescriptor()
{
return descriptor;
}
/**
* Returns the list of {@link Format}s to produce.
*
* @return the list of formats.
*/
public List getFormats()
{
return formats;
}
/**
* Returns the base directory of source files.
*
* @return the base directory.
*/
public String getDirectory()
{
return directory;
}
/**
* Returns the list of files to include.
*
* @return the list of files to include.
*/
public List getIncludes()
{
return includes;
}
/**
* Returns the list of files to exclude.
*
* @return the list of files to exclude.
*/
public List getExcludes()
{
return excludes;
}
}
././@LongLink 0000000 0000000 0000000 00000000145 00000000000 011565 L ustar root root doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java doxia-1.1.4/doxia-maven-plugin/src/main/java/org/apache/maven/doxia/plugin/DoxiaRenderBooksMojo.java0000644 0001750 0001750 00000025656 11242734614 033353 0 ustar twerner twerner package org.apache.maven.doxia.plugin;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.book.BookDoxia;
import org.apache.maven.doxia.book.BookDoxiaException;
import org.apache.maven.doxia.book.InvalidBookDescriptorException;
import org.apache.maven.doxia.book.model.BookModel;
import org.apache.maven.doxia.book.services.validation.ValidationResult;
import org.apache.maven.doxia.tools.SiteTool;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
import org.codehaus.plexus.util.FileUtils;
import org.codehaus.plexus.util.ReaderFactory;
import org.codehaus.plexus.util.StringUtils;
import java.io.File;
import java.io.IOException;
import java.util.Iterator;
import java.util.List;
import java.util.Locale;
/**
* A Mojo to create books in different output formats.
*
* @goal render-books
* @author Trygve Laugstøl
* @version $Id: DoxiaRenderBooksMojo.java 805701 2009-08-19 08:36:28Z ltheussl $
* @since 1.0
*/
public class DoxiaRenderBooksMojo
extends AbstractMojo
{
/** System EOL. */
private static final String LINE_SEPARATOR = System.getProperty( "line.separator" );
// ----------------------------------------------------------------------
// Mojo components
// ----------------------------------------------------------------------
/**
* BookDoxia component
*
* @component
*/
private BookDoxia bookDoxia;
/**
* SiteTool.
*
* @component
*/
protected SiteTool siteTool;
// ----------------------------------------------------------------------
// Mojo parameters
// ----------------------------------------------------------------------
/**
* A list of books.
*
* @parameter
* @required
*/
private List books;
/**
* Base directory of the project.
*
* @parameter default-value="${basedir}"
*/
private File basedir;
/**
* Directory containing the generated project docs.
*
* @parameter default-value="${project.build.directory}/generated-site"
*/
private File generatedDocs;
/**
* A comma separated list of locales supported by Maven. The first valid token will be the default Locale
* for this instance of the Java Virtual Machine.
*
* @parameter default-value="${locales}"
*/
protected String locales;
/**
* Specifies the input encoding.
*
* @parameter expression="${encoding}" default-value="${project.build.sourceEncoding}"
*/
private String inputEncoding;
/**
* Specifies the output encoding.
*
* @parameter expression="${outputEncoding}" default-value="${project.reporting.outputEncoding}"
*/
private String outputEncoding;
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
/**
* {@inheritDoc}
*
* Executes the Mojo.
*/
public void execute()
throws MojoExecutionException, MojoFailureException
{
for ( Iterator it = books.iterator(); it.hasNext(); )
{
Book book = (Book) it.next();
// ----------------------------------------------------------------------
// Validate
// ----------------------------------------------------------------------
if ( StringUtils.isEmpty( book.getDescriptor() ) )
{
throw new MojoFailureException( "Invalid configuration: "
+ "The book is required to have a descriptor set." );
}
if ( StringUtils.isEmpty( book.getDirectory() ) )
{
throw new MojoFailureException( "Invalid configuration: "
+ "The book is required to have a directory set." );
}
if ( book.getFormats() == null || book.getFormats().size() == 0 )
{
throw new MojoFailureException( "Invalid configuration: "
+ "The book is required to have at least one format set." );
}
// ----------------------------------------------------------------------
//
// ----------------------------------------------------------------------
File descriptor = new File( basedir, book.getDescriptor() );
String includes = "";
if ( book.getIncludes() != null )
{
for ( Iterator j = book.getIncludes().iterator(); j.hasNext(); )
{
String include = (String) j.next();
includes += include + ",";
}
}
else
{
includes = "**/*";
}
String excludes = "";
if ( book.getExcludes() != null )
{
for ( Iterator j = book.getExcludes().iterator(); j.hasNext(); )
{
String exclude = (String) j.next();
excludes += exclude + ",";
}
}
// ----------------------------------------------------------------------
// Find all the files to pass to the renderer.
// ----------------------------------------------------------------------
if ( getLog().isDebugEnabled() )
{
getLog().debug( "Locating files to include in the book:" );
getLog().debug( "Basedir: " + basedir );
getLog().debug( "Includes: " + includes );
getLog().debug( "Excludes: " + excludes );
}
List files;
try
{
files = FileUtils.getFiles( new File( basedir, book.getDirectory() ), includes, excludes );
}
catch ( IOException e )
{
throw new MojoExecutionException( "Error while looking for input files. " + "Basedir="
+ basedir.getAbsolutePath() + ", " + "includes=" + includes + ", " + "excludes=" + excludes, e );
}
// -----------------------------------------------------------------------
// Load the model
// -----------------------------------------------------------------------
BookModel bookModel;
try
{
bookModel = bookDoxia.loadBook( descriptor );
}
catch ( InvalidBookDescriptorException e )
{
throw new MojoFailureException( "Invalid book descriptor: " + LINE_SEPARATOR
+ formatResult( e.getValidationResult() ) );
}
catch ( BookDoxiaException e )
{
throw new MojoExecutionException( "Error while loading the book descriptor", e );
}
// -----------------------------------------------------------------------
// Render the book in all the formats
// -----------------------------------------------------------------------
List localesList = siteTool.getAvailableLocales( locales );
// Default is first in the list
Locale defaultLocale = (Locale) localesList.get( 0 );
Locale.setDefault( defaultLocale );
for ( Iterator iterator = localesList.iterator(); iterator.hasNext(); )
{
Locale locale = (Locale) iterator.next();
for ( Iterator j = book.getFormats().iterator(); j.hasNext(); )
{
Format format = (Format) j.next();
File outputDirectory = new File( generatedDocs, format.getId() );
File directory = new File( outputDirectory + "/" + locale.toString(), bookModel.getId() );
if ( locale.equals( defaultLocale ) )
{
directory = new File( outputDirectory, bookModel.getId() );
}
try
{
bookDoxia.renderBook( bookModel, format.getId(), files, directory, locale,
getInputEncoding(), getOutputEncoding() );
}
catch ( BookDoxiaException e )
{
throw new MojoExecutionException( "Error while generating book in format '"
+ format.getId() + "'.", e );
}
}
}
}
}
/**
* Gets the input files encoding.
*
* @return The input files encoding, never null.
* @since 1.1
*/
protected String getInputEncoding()
{
return ( inputEncoding == null ) ? ReaderFactory.ISO_8859_1 : inputEncoding;
}
/**
* Gets the effective reporting output files encoding.
*
* @return The effective reporting output file encoding, never null.
* @since 1.1
*/
protected String getOutputEncoding()
{
return ( outputEncoding == null ) ? ReaderFactory.UTF_8 : outputEncoding;
}
/**
* Returns a formatted message of a ValidationResult.
*
* @param result the ValidationResult to format.
* @return the formatted result.
*/
private String formatResult( ValidationResult result )
{
StringBuffer buffer = new StringBuffer();
if ( result.getErrors().size() > 0 )
{
buffer.append( "Validation errors:" );
for ( Iterator it = result.getErrors().iterator(); it.hasNext(); )
{
String error = (String) it.next();
buffer.append( LINE_SEPARATOR ).append( " " ).append( error );
}
}
if ( result.getWarnings().size() > 0 )
{
buffer.append( "Validation warnings:" );
for ( Iterator it = result.getWarnings().iterator(); it.hasNext(); )
{
String error = (String) it.next();
buffer.append( LINE_SEPARATOR ).append( " " ).append( error );
}
}
return buffer.toString();
}
}
Maven ${currentVersion}
(1.3Mb)
Continuum
continuous integration server
Maven 1.x
All stories start at the beginning...
images. 
![](\"img.src\"/)
";
parser.parse( text, sink );
Iterator it = sink.getEventList().iterator();
assertEquals( "lineBreak", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "horizontalRule", ( (SinkEventElement) it.next() ).getName() );
assertEquals( "figureGraphics", ( (SinkEventElement) it.next() ).getName() );
}
/** @throws Exception */
public void testSpecial()
throws Exception
{
String text = "![](\"src.jpg\"/)
![\"image\"/](\"http://ex.com/ex.jpg?v=l&l=e\")
";
parser.parse( text, sink );
it = sink.getEventList().iterator();
event = (SinkEventElement) it.next();
assertEquals( "figureGraphics", event.getName() );
attribs = (SinkEventAttributeSet) event.getArgs()[1];
// ampersand should be un-escaped
assertEquals( "http://ex.com/ex.jpg?v=l&l=e", attribs.getAttribute( "src" ) );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTestCase.java 0000644 0001750 0001750 00000004414 11151220275 032234 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.SinkAdapter;
import org.codehaus.plexus.PlexusTestCase;
import java.io.FileReader;
import java.io.Reader;
/**
* Test the parsing of sample input files
*
* @author Carlos Sanchez
* @author Emmanuel Venisse
* @version $Id: AbstractParserTestCase.java 747735 2009-02-25 10:43:09Z ltheussl $
* @since 1.0
*/
public abstract class AbstractParserTestCase
extends PlexusTestCase
{
/**
* Parser to use to convert input to sink events
*
* @return the parser to use
*/
protected abstract Parser getParser();
/**
* Path of the model to test, relative to basedir
*
* @return the relative path
*/
protected abstract String getDocument();
/**
* Sink to write the output of the parsing
*
* @return a SinkAdapter if not overridden
*/
protected Sink getSink()
{
return new SinkAdapter();
}
/**
* Parse the model in the path specified by {@link #getDocument()},
* with parser from {@link #getParser()}, and output to sink from {@link #getSink()}
*
* @throws Exception if any.
*/
public void testParser()
throws Exception
{
Reader reader = new FileReader( getTestFile( getBasedir(), getDocument() ) );
getParser().parse( reader, getSink() );
}
}
doxia-1.1.4/doxia-core/src/test/java/org/apache/maven/doxia/parser/AbstractParserTest.java 0000644 0001750 0001750 00000007170 11134645700 031447 0 ustar twerner twerner package org.apache.maven.doxia.parser;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
import org.apache.maven.doxia.AbstractModuleTest;
import org.apache.maven.doxia.sink.WellformednessCheckingSink;
import org.apache.maven.doxia.sink.Sink;
import org.apache.maven.doxia.sink.TextSink;
import org.codehaus.plexus.util.IOUtil;
import java.io.IOException;
import java.io.Reader;
import java.io.Writer;
/**
* Test the parsing of sample input files.
* ![\"\"](\"src.jpg\")
![\"\"](\"source.png\")
", writer.toString() );
}
/**
* Test of paragraph method, of class XhtmlBaseSink.
*/
public void testParagraph()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.paragraph();
sink.paragraph_();
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
writer = new StringWriter();
try
{
sink = new XhtmlBaseSink( writer );
sink.paragraph( attributes );
sink.paragraph_();
}
finally
{
sink.close();
}
assertEquals( "", writer.toString() );
}
/**
* Test of verbatim method, of class XhtmlBaseSink.
*/
public void testVerbatim()
{
try
{
sink = new XhtmlBaseSink( writer );
sink.verbatim( true );
sink.verbatim_();
}
finally
{
sink.close();
}
assertEquals( "