HeaderDoc::LineRange

Declared In:

Introduction

Describes a range of lines in a header file.

Discussion

The LineRange class stores a range of (raw) lines from a header file, along with information about the line numbers that they came from within the header. This is used to simplify handling of #if directives.

Member Functions

_initialize: Initializes an instance of a LineRange object.
end: Getter/setter for the end of the range.
inrange: Returns whether the specified line number falls within this LineRange.
new: Creates a new LineRange object.
start: Getter/setter for the start of the range.
text: Getter/setter for text derived from range.

_initialize

Initializes an instance of a LineRange object.

sub _initialize

Parameters

self: The object to initialize.

end

Getter/setter for the end of the range.

sub end

Parameters

self: This LineRange object.

inrange

Returns whether the specified line number falls within this LineRange.

sub inrange

Parameters

line: The line number to check.

new

Creates a new LineRange object.

sub new

Parameters

param: A reference to the relevant package object (e.g. HeaderDoc::LineRange->new() to allocate a new instance of this class).

start

Getter/setter for the start of the range.

sub start

Parameters

self: This LineRange object.

text

Getter/setter for text derived from range.

sub text

Discussion

Basically, this is the result of parsing availabilty macros and similar.

Member Data

_end: The ending line number.
_start: The starting line number.
_text: A string containing the raw source code from this range of lines.
HeaderDoc::LineRange::VERSION: The revision control revision number for this module.

_end

The ending line number.

$self->{_end}

_start

The starting line number.

$self->{_start}

_text

A string containing the raw source code from this range of lines.

$self->{_text}

HeaderDoc::LineRange::VERSION

The revision control revision number for this module.

$HeaderDoc::LineRange::VERSION = '$Revision: 1298084578 $';

Discussion

In the git repository, contains the number of seconds since January 1, 1970.

Last Updated: Saturday, August 06, 2016