org.extex.typesetter.tex.paragraph
Class ActiveNode

java.lang.Object
  org.extex.typesetter.tex.paragraph.ActiveNode

public class ActiveNode
extends java.lang.Object

819. An active node for a given breakpoint contains six fields:

• link points to the next node in the list of active nodes; the last active node has link=last_active.
• break_node points to the passive node associated with this breakpoint.
• line_number is the number of the line that follows this breakpoint.
• fitness is the fitness classification of the line ending at this breakpoint.
• type is either hyphenated or unhyphenated, depending on whether this breakpoint is a disc_node.
• total_demerits is the minimum possible sum of demerits over all lines leading from the beginning of the paragraph to this breakpoint.

The value of link(active) points to the first active node on a linked list of all currently active nodes. This list is in order by line_number, except that nodes with line_number > easy_line may be in any order relative to each other.

 define active_node_size=3  {number of words in active nodes}

 define fitness ::= subtype  {very_loose_fit .. tight_fit on final line for this break}

 define break_node ::= rlink  {pointer to the corresponding passive node}

 define line_number ::= llink  {line that begins at this breakpoint}

 define total_demerits(#) ::= mem[#+2].int  {the quantity that TeX minimizes}

 define unhyphenated=0  {the type of a normal active break node}

 define hyphenated=1  {the type of an active node that breaks at a disc_node}

 define last_active ::= active  {the active list ends where it begins}
 

Version:

$Revision$

Author:

Gerd Neugebauer

Constructor Summary

ActiveNode(Fitness fitness, boolean hyphenated, long demerits, int lineNumber, PassiveNode breakNode)
Creates a new object.

Method Summary

protected PassiveNode	getBreakNode() Getter for breakNode.
protected Fitness	getFitness() Getter for fitness.
protected int	getLineNumber() Getter for lineNumber.
protected long	getTotalDemerits() Getter for demerits.
protected boolean	isHyphenated() Getter for hyphenated.
java.lang.String	toString() Return the printable representation of the instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ActiveNode

public ActiveNode(Fitness fitness,
                  boolean hyphenated,
                  long demerits,
                  int lineNumber,
                  PassiveNode breakNode)

Creates a new object.

Parameters:

fitness - the fitness classification

hyphenated - the indicator for hyphenation at this break point

demerits - the demerits for this break point

lineNumber - the sequence number of the line

breakNode - the index of the break

Method Detail

getBreakNode

protected PassiveNode getBreakNode()

Getter for breakNode.

Returns:

the breakNode

getFitness

protected Fitness getFitness()

Getter for fitness.

Returns:

the fitness

getLineNumber

protected int getLineNumber()

Getter for lineNumber.

Returns:

the lineNumber

getTotalDemerits

protected long getTotalDemerits()

Getter for demerits.

Returns:

the demerits

isHyphenated

protected boolean isHyphenated()

Getter for hyphenated.

Returns:

the hyphenated

toString

public java.lang.String toString()

Return the printable representation of the instance.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

See Also:

Object.toString()