class Includer extends Iterator[String]
Process "include" directives in files, returning an iterator over lines from the flattened files.
The grizzled.file.Includer
class can be used to process "include"
directives within a text file, returning a file-like object. It also
contains some utility functions that permit using include-enabled files
in other contexts.
WARNING: This class is not thread-safe.
Syntax
The include syntax is defined by a regular expression; any
line that matches the regular expression is treated as an include
directive. The default regular expression, %include\s"(["]+)"$
matches include directives like this:
%include "/absolute/path/to/file" %include "../relative/path/to/file" %include "local_reference" %include "http://localhost/path/to/my.config"
Relative and local file references are relative to the including file
or URL. That is, if an Includer
is processing file
"/home/bmc/foo.txt" and encounters an attempt to include file "bar.txt",
it will assume "bar.txt" is to be found in "/home/bmc".
Similarly, if an Includer
is processing URL
"http://localhost/bmc/foo.txt" and encounters an attempt to include file
"bar.txt", it will assume "bar.txt" is to be found at
"http://localhost/bmc/bar.txt".
Nested includes are permitted; that is, an included file may, itself, include other files. The maximum recursion level is configurable and defaults to 100.
The include syntax can be changed by passing a different regular
expression to the Includer
constructor.
Usage
This package provides an Includer
class, which processes include
directives in a file and behaves somewhat like a Scala Source
. See the
class documentation for more details.
The package also provides a preprocess()
convenience function, via a
companion object, that can be used to preprocess a file; it returns the
path to the resulting preprocessed file.
Examples
Preprocess a file containing include directives, then read the result:
import grizzled.file.Includer
Includer(path).foreach(println(_))
Use an include-enabled file with a Scala scala.io.Source
object:
import grizzled.file.includer.Includer import scala.io.Source val source = Source.fromFile(Includer.preprocess("/path/to/file"))
- Alphabetic
- By Inheritance
- Includer
- Iterator
- TraversableOnce
- GenTraversableOnce
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
class
GroupedIterator[B >: A] extends AbstractIterator[Seq[B]] with Iterator[Seq[B]]
- Definition Classes
- Iterator
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
++[B >: String](that: ⇒ GenTraversableOnce[B]): Iterator[B]
- Definition Classes
- Iterator
-
def
/:[B](z: B)(op: (B, String) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
:\[B](z: B)(op: (String, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
addString(b: StringBuilder): StringBuilder
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, sep: String): StringBuilder
- Definition Classes
- TraversableOnce
-
def
addString(b: StringBuilder, start: String, sep: String, end: String): StringBuilder
- Definition Classes
- TraversableOnce
-
def
aggregate[B](z: ⇒ B)(seqop: (B, String) ⇒ B, combop: (B, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
buffered: BufferedIterator[String]
- Definition Classes
- Iterator
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
collect[B](pf: PartialFunction[String, B]): Iterator[B]
- Definition Classes
- Iterator
- Annotations
- @migration
- Migration
(Changed in version 2.8.0)
collect
has changed. The previous behavior can be reproduced withtoSeq
.
-
def
collectFirst[B](pf: PartialFunction[String, B]): Option[B]
- Definition Classes
- TraversableOnce
-
def
contains(elem: Any): Boolean
- Definition Classes
- Iterator
-
def
copyToArray[B >: String](xs: Array[B], start: Int, len: Int): Unit
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
copyToArray[B >: String](xs: Array[B]): Unit
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToArray[B >: String](xs: Array[B], start: Int): Unit
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
copyToBuffer[B >: String](dest: Buffer[B]): Unit
- Definition Classes
- TraversableOnce
-
def
corresponds[B](that: GenTraversableOnce[B])(p: (String, B) ⇒ Boolean): Boolean
- Definition Classes
- Iterator
-
def
count(p: (String) ⇒ Boolean): Int
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
drop(n: Int): Iterator[String]
- Definition Classes
- Iterator
-
def
dropWhile(p: (String) ⇒ Boolean): Iterator[String]
- Definition Classes
- Iterator
-
def
duplicate: (Iterator[String], Iterator[String])
- Definition Classes
- Iterator
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
exists(p: (String) ⇒ Boolean): Boolean
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
filter(p: (String) ⇒ Boolean): Iterator[String]
- Definition Classes
- Iterator
-
def
filterNot(p: (String) ⇒ Boolean): Iterator[String]
- Definition Classes
- Iterator
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
find(p: (String) ⇒ Boolean): Option[String]
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
flatMap[B](f: (String) ⇒ GenTraversableOnce[B]): Iterator[B]
- Definition Classes
- Iterator
-
def
fold[A1 >: String](z: A1)(op: (A1, A1) ⇒ A1): A1
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldLeft[B](z: B)(op: (B, String) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
foldRight[B](z: B)(op: (String, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
forall(p: (String) ⇒ Boolean): Boolean
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
foreach[U](f: (String) ⇒ U): Unit
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
grouped[B >: String](size: Int): GroupedIterator[B]
- Definition Classes
- Iterator
-
def
hasDefiniteSize: Boolean
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
hasNext: Boolean
Determine whether there are any more input lines to be read from the includer.
Determine whether there are any more input lines to be read from the includer.
- returns
true
if at least one more line is available,false
otherwise
- Definition Classes
- Includer → Iterator
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val includeRegex: Regex
-
def
indexOf[B >: String](elem: B, from: Int): Int
- Definition Classes
- Iterator
-
def
indexOf[B >: String](elem: B): Int
- Definition Classes
- Iterator
-
def
indexWhere(p: (String) ⇒ Boolean, from: Int): Int
- Definition Classes
- Iterator
-
def
indexWhere(p: (String) ⇒ Boolean): Int
- Definition Classes
- Iterator
-
def
isEmpty: Boolean
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isTraversableAgain: Boolean
- Definition Classes
- Iterator → GenTraversableOnce
-
def
length: Int
- Definition Classes
- Iterator
-
def
map[B](f: (String) ⇒ B): Iterator[B]
- Definition Classes
- Iterator
-
def
max[B >: String](implicit cmp: Ordering[B]): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
maxBy[B](f: (String) ⇒ B)(implicit cmp: Ordering[B]): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
- val maxNesting: Int
-
def
min[B >: String](implicit cmp: Ordering[B]): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
minBy[B](f: (String) ⇒ B)(implicit cmp: Ordering[B]): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString: String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(sep: String): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
mkString(start: String, sep: String, end: String): String
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
next(): String
Get the next input line.
Get the next input line. You should call
hasNext
before calling this method, to ensure that there are input lines remaining. Callingnext
on an emptyIncluder
will result in a runtime exception- returns
the next input line
- Definition Classes
- Includer → Iterator
- Annotations
- @SuppressWarnings()
-
def
nonEmpty: Boolean
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
padTo[A1 >: String](len: Int, elem: A1): Iterator[A1]
- Definition Classes
- Iterator
-
def
partition(p: (String) ⇒ Boolean): (Iterator[String], Iterator[String])
- Definition Classes
- Iterator
-
def
patch[B >: String](from: Int, patchElems: Iterator[B], replaced: Int): Iterator[B]
- Definition Classes
- Iterator
-
def
product[B >: String](implicit num: Numeric[B]): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduce[A1 >: String](op: (A1, A1) ⇒ A1): A1
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceLeft[B >: String](op: (B, String) ⇒ B): B
- Definition Classes
- TraversableOnce
-
def
reduceLeftOption[B >: String](op: (B, String) ⇒ B): Option[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceOption[A1 >: String](op: (A1, A1) ⇒ A1): Option[A1]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRight[B >: String](op: (String, B) ⇒ B): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reduceRightOption[B >: String](op: (String, B) ⇒ B): Option[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
reversed: List[String]
- Attributes
- protected[this]
- Definition Classes
- TraversableOnce
-
def
sameElements(that: Iterator[_]): Boolean
- Definition Classes
- Iterator
-
def
scanLeft[B](z: B)(op: (B, String) ⇒ B): Iterator[B]
- Definition Classes
- Iterator
-
def
scanRight[B](z: B)(op: (String, B) ⇒ B): Iterator[B]
- Definition Classes
- Iterator
-
def
seq: Iterator[String]
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
size: Int
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
sizeHintIfCheap: Int
- Attributes
- protected[scala.collection]
- Definition Classes
- GenTraversableOnce
-
def
slice(from: Int, until: Int): Iterator[String]
- Definition Classes
- Iterator
-
def
sliceIterator(from: Int, until: Int): Iterator[String]
- Attributes
- protected
- Definition Classes
- Iterator
-
def
sliding[B >: String](size: Int, step: Int): GroupedIterator[B]
- Definition Classes
- Iterator
- val source: IncludeSource
-
def
span(p: (String) ⇒ Boolean): (Iterator[String], Iterator[String])
- Definition Classes
- Iterator
-
def
sum[B >: String](implicit num: Numeric[B]): B
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
take(n: Int): Iterator[String]
- Definition Classes
- Iterator
-
def
takeWhile(p: (String) ⇒ Boolean): Iterator[String]
- Definition Classes
- Iterator
-
def
to[Col[_]](implicit cbf: CanBuildFrom[Nothing, String, Col[String]]): Col[String]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toArray[B >: String](implicit arg0: ClassTag[B]): Array[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toBuffer[B >: String]: Buffer[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toIndexedSeq: IndexedSeq[String]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toIterable: Iterable[String]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toIterator: Iterator[String]
- Definition Classes
- Iterator → GenTraversableOnce
-
def
toList: List[String]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toMap[T, U](implicit ev: <:<[String, (T, U)]): Map[T, U]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toSeq: Seq[String]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toSet[B >: String]: Set[B]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
def
toStream: Stream[String]
- Definition Classes
- Iterator → GenTraversableOnce
-
def
toString(): String
- Definition Classes
- Iterator → AnyRef → Any
-
def
toTraversable: Traversable[String]
- Definition Classes
- Iterator → TraversableOnce → GenTraversableOnce
-
def
toVector: Vector[String]
- Definition Classes
- TraversableOnce → GenTraversableOnce
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
def
withFilter(p: (String) ⇒ Boolean): Iterator[String]
- Definition Classes
- Iterator
-
def
zip[B](that: Iterator[B]): Iterator[(String, B)]
- Definition Classes
- Iterator
-
def
zipAll[B, A1 >: String, B1 >: B](that: Iterator[B], thisElem: A1, thatElem: B1): Iterator[(A1, B1)]
- Definition Classes
- Iterator
-
def
zipWithIndex: Iterator[(String, Int)]
- Definition Classes
- Iterator