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 The file should be an ordinary text file, consisting of a series of
15 lines, with each line completely containing the information for a
16 single item. Blank lines, or lines beginning with the hash character
17 '#' will be ignored as comments.
18
19 For a single item line, only word characters will be used. A 'word
20 character' consists of all letters and numbers, and the underscore '_'
21 character. Anything that is not a word character will be assumed to be
22 a seperator.
23
24 The first word will be used as the name or id of the item, and any
25 further words in the line will be used as other items that this one
26 depends on. For example, all of the following are legal.
27
28 # A single item with no dependencies
29 Foo
30
31 # Another item that depends on the first one
32 Bar Foo
33
34 # Depending on multiple others
35 Bin Foo Bar
36
37 # We can use different seperators
38 One:Two|Three-Four+Five=Six Seven
39
40 # We can also use multiple non-word characters as seperators
41 This&*&^*&File: is& & & :::REALLY()Neat
42
43 From the examples above, it should be easy to create your own files.
44
46 This documents the methods differing from the ordinary
47 Algorithm::Dependency::Source methods.
48
49 new $filename
50 When constructing a new Algorithm::Dependency::Source::File object, an
51 argument should be provided of the name of the file to use. The
52 constructor will check that the file exists, and is readable, returning
53 "undef" otherwise.
54
56 To file a bug against this module, use the CPAN bug tracking system
57
58 <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Algorithm-Dependency>
59
60 For other comments, contact the author.
61
63 Adam Kennedy <adamk@cpan.org>
64
66 Algorithm::Dependency
67
69 Copyright 2003 - 2009 Adam Kennedy.
70
71 This program is free software; you can redistribute it and/or modify it
72 under the same terms as Perl itself.
73
74 The full text of the license can be found in the LICENSE file included
75 with this module.
76
77
78
79perl v5.28.0 2009-04A-l1g4orithm::Dependency::Source::File(3)