1Algorithm::Dependency::USsoeurrcCeo:n:tFriilbeu(t3e)d PeArllgoDroictuhmme:n:tDaetpieonndency::Source::File(3)
2
3
4
6 Algorithm::Dependency::Source::File - File source for dependency
7 heirachys
8
10 Algorithm::Dependency::Source::File implements a source where the items
11 are stored in a flat file or a relatively simple format.
12
13 File Format
14
15 The file should be an ordinary text file, consisting of a series of
16 lines, with each line completely containing the information for a sin‐
17 gle item. Blank lines, or lines beginning with the hash character '#'
18 will be ignored as comments.
19
20 For a single item line, only word characters will be used. A 'word
21 character' consists of all letters and numbers, and the underscore '_'
22 character. Anything that is not a word character will be assumed to be
23 a seperator.
24
25 The first word will be used as the name or id of the item, and any fur‐
26 ther words in the line will be used as other items that this one
27 depends on. For example, all of the following are legal.
28
29 # A single item with no dependencies
30 Foo
31
32 # Another item that depends on the first one
33 Bar Foo
34
35 # Depending on multiple others
36 Bin Foo Bar
37
38 # We can use different seperators
39 One:Two⎪Three-Four+Five=Six Seven
40
41 # We can also use multiple non-word characters as seperators
42 This&*&^*&File: is& & & :::REALLY()Neat
43
44 From the examples above, it should be easy to create your own files.
45
47 This documents the methods differing from the ordinary Algo‐
48 rithm::Dependency::Source methods.
49
50 new $filename
51
52 When constructing a new Algorithm::Dependency::Source::File object, an
53 argument should be provided of the name of the file to use. The con‐
54 structor will check that the file exists, and is readable, returning
55 "undef" otherwise.
56
58 To file a bug against this module, use the CPAN bug tracking system
59
60 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Algorithm-Dependency>
61
62 For other comments, contact the author.
63
65 Adam Kennedy, <http://ali.as/>, cpan@ali.as
66
68 Algorithm::Dependency
69
71 Copyright (c) 2003 - 2005 Adam Kennedy.
72
73 This program is free software; you can redistribute it and/or modify it
74 under the same terms as Perl itself.
75
76 The full text of the license can be found in the LICENSE file included
77 with this module.
78
79
80
81perl v5.8.8 2008-01A-l1g4orithm::Dependency::Source::File(3)