summaryrefslogtreecommitdiff
path: root/README
blob: 9597bae71245623d70703a3272b1cf7390fe4ca8 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
[Eo_info]

Eo_Info is a tool aimed to show specific Eolian information about classes. It enables easily graphical/text representation of chosen eo classes.
Eolian is used to get this information.
The output is a .dot file, convertible to other formats with Graphviz

[Compiling and installing]
   [Source Download]
      https://git.enlightenment.org/devs/avilog/eo_info.git

   [Dependencies]
      Mandatory:
         - EFL, Elementary version >= 1.13
         - CMake

   [Building]
      $ cd eo_info
      $ mkdir build
      $ cd build
      $ cmake ..
      $ make

   [Installing]
      (run from "build" directory)
      $ sudo make install

   [Unstalling]
      (run from "build" directory)
      $ sudo make uninstall

[Usage]
    [Command line options]
    --help/-h                  Display this information
    --no-inheritance/-n        By default we create the Inheritance tree, this flag disables it.
    --inheritors/-i            Add the Inheritors tree (classes that inherit from this class)
    --output/-o <outFile>      Set output filename to <outFile>
    --depth/-d  <depth>        Set <depth> to be the max depth (up and down  from the class) of the printed tree)
    --include/-I <includeDir>  Add <includeDir> to the list of include
                               dirs for scanning. If no directory included we scan the system dir.
    --filters/-f <filter1,...> Set filters (the info of the class that will be printed) as a comma-separated list of:
                                  events, file

    [examples - from root dir]
        Get dot representation of inheritance tree of elm_layout.eo till depth 3.
        Using system Eo files (used when no include is defined).
        $ ./build/src/bin/eo_info_cmd -d 3 -o test.dot elm_layout.eo

        Get dot representation of inheritors tree of elm_layout.eo and elm_button.eo till depth 3.
        $ ./build/src/bin/eo_info_cmd -d 3 -n -i -o test.dot elm_layout.eo Elm.Button
     
        Get dot representation of inheritance tree of elm_layout.eo till depth 3.
        Using user defined Eo files dirs.
        $ ./build/src/bin/eo_info_cmd -d 3 -o test.dot -I /home/avilog/git/efl/efl/src/lib/ -I /home/avilog/git/efl/elementary/src/lib/ elm_layout.eo

[other]
If you have Graphviz installed, you can convert the dot file to many other formats:
SVG:
  dot -Tsvg test.dot -o test.svg
PNG:
  dot -Tpng test.dot -o test.png