git.iko.soy/SourceDocsSwift
on master help sign in
Added styling
99562b7ilyakooo0
README.md+11−1
compare with master
unifiedsplit
@@ -11,7 +11,11 @@ brew install ilyakooo0/tap/sourceDocsSwift
11## Использование
11## Использование
12
12
13```bash
13```bash
14−sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/doc.tex
14+sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/doc.tex -s latex -l 1
15+```
16+
17+```bash
18+sourceDocsSwift -s tech -l 2
15```
19```
16
20
17По умолчанию ищет проект в текущей папке и пишет результат в эту же папку в файл `doc.tex`.
21По умолчанию ищет проект в текущей папке и пишет результат в эту же папку в файл `doc.tex`.
@@ -27,3 +31,9 @@ sourceDocsSwift -i path/to/XcodePrjectDirectory/ -o path/to/output/doc.tex
27```LaTeX
31```LaTeX
28\usepackage{longtable}
32\usepackage{longtable}
29```
33```
34+### Параметры
35+
36+- `[-s | --style] [latex | tech]` -- стиль команды самого внешнего уровня
37+- `[-l | --level] [1 | 2 | 3]` -- отступ в уровнях
38+- `[-i | --input] path/to/projectDirectory` -- путь к папке с проектом
39+- `[-o | --output] path/to/output.tex` -- путь к фалу, в который писать результат
SourceDocsSwift/TeXer.swift+45−8
@@ -7,24 +7,24 @@
7//
7//
8
8
9struct TeXer {
9struct TeXer {
10− static func convert(objects: [Object]) -> String {
10+ static func convert(objects: [Object], with style: TexType = .laTeX(2)) -> String {
11 return """
11 return """
12− \\subsection{Описание классов и структур}
12+ \\\(style.section(for: 1)){Описание классов и структур}
13
13
14 \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}
14 \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}
15 \\hline
15 \\hline
16 \\textbf{Класс или стркура} & \\textbf{Описание} \\\\ \\hline
16 \\textbf{Класс или стркура} & \\textbf{Описание} \\\\ \\hline
17 \( objects.map {"\\texttt{\($0.declaration)} & \($0.documentation ?? "{\\color{red} TODO}") \\\\ \\hline"} .joined(separator: "\n") )
17 \( objects.map {"\\texttt{\($0.declaration)} & \($0.documentation ?? "{\\color{red} TODO}") \\\\ \\hline"} .joined(separator: "\n") )
18 \\end{longtable}
18 \\end{longtable}
19−
20
19
20+
21− \\subsection{Описание полей классов и структур}
21+ \\\(style.section(for: 1)){Описание полей классов и структур}
22
22
23 \(
23 \(
24 objects.compactMap {
24 objects.compactMap {
25 if $0.fields.count > 0 {
25 if $0.fields.count > 0 {
26 return """
26 return """
27− \\subsubsection{\\texttt{\($0.declaration)}}
27+ \\\(style.section(for: 2))*{\\texttt{\($0.declaration)}}
28
28
29 \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}
29 \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}
30 \\hline
30 \\hline
@@ -38,14 +38,14 @@ struct TeXer {
38 }
38 }
39 } .joined(separator: "\n")
39 } .joined(separator: "\n")
40 )
40 )
41−
41+
42− \\subsection{Описание методов классов и структур}
42+ \\\(style.section(for: 1)){Описание методов классов и структур}
43
43
44 \(
44 \(
45 objects.compactMap {
45 objects.compactMap {
46 if $0.methods.count > 0 {
46 if $0.methods.count > 0 {
47 return """
47 return """
48− \\subsubsection{\\texttt{\($0.declaration)}}
48+ \\\(style.section(for: 2))*{\\texttt{\($0.declaration)}}
49
49
50 \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}
50 \\begin{longtable}{|p{0.55\\textwidth} | p{0.4\\textwidth}|}
51 \\hline
51 \\hline
@@ -61,4 +61,41 @@ struct TeXer {
61 )
61 )
62 """
62 """
63 }
63 }
64+
65+ enum TexType {
66+ case techDoc(Int)
67+ case laTeX(Int)
68+
69+ func section(`for` level: Int) -> String {
70+ switch self {
71+ case .laTeX(let i):
72+ return String(repeating: "sub", count: i+level-2).appending("section")
73+ case .techDoc(let i):
74+ switch i+level-2 {
75+ case 0:
76+ return "addition"
77+ default:
78+ return TexType.laTeX(i).section(for: level)
79+ }
80+ }
81+ }
82+ var levelOffset: Int {
83+ get {
84+ switch self {
85+ case .laTeX(let i):
86+ return i
87+ case .techDoc(let i):
88+ return i
89+ }
90+ }
91+ set {
92+ switch self {
93+ case .laTeX(_):
94+ self = .laTeX(newValue)
95+ case .techDoc(_):
96+ self = .techDoc(newValue)
97+ }
98+ }
99+ }
100+ }
64}
101}
SourceDocsSwift/main.swift+40−3
@@ -13,20 +13,57 @@ let args = Array(CommandLine.arguments.dropFirst())
13
13
14var output = "docs.tex"
14var output = "docs.tex"
15var directory: String?
15var directory: String?
16+var style: TeXer.TexType = .laTeX(2)
16
17
17var i = 0
18var i = 0
18while i < args.count {
19while i < args.count {
19 switch args[i] {
20 switch args[i] {
20− case "-o":
21+ case "-o", "--output":
21 if i + 1 < args.count {
22 if i + 1 < args.count {
22 i += 1
23 i += 1
23 output = args[i]
24 output = args[i]
24 }
25 }
25− case "-i":
26+ case "-i", "--input":
26 if i + 1 < args.count {
27 if i + 1 < args.count {
27 i += 1
28 i += 1
28 directory = args[i]
29 directory = args[i]
29 }
30 }
31+ case "-s", "--style":
32+ if i + 1 < args.count {
33+ i += 1
34+ switch args[i].lowercased() {
35+ case "latex", "xetex", "tex":
36+ style = .laTeX(style.levelOffset)
37+ case "tech", "techdoc", "techdocs":
38+ style = .techDoc(style.levelOffset)
39+ default:
40+ print("""
41+ That is not a valid style.
42+
43+ Valid styles are:
44+ latex
45+ techdoc
46+ """)
47+ exit(1)
48+ }
49+ }
50+ case "-l", "--level":
51+ if i + 1 < args.count {
52+ i += 1
53+ guard let l = Int(args[i]) else {
54+ print("""
55+ That is not a valid int.
56+ """)
57+ exit(1)
58+ }
59+ if l < 1 {
60+ print("""
61+ Level must be greater or equal to 1.
62+ """)
63+ exit(1)
64+ }
65+ style.levelOffset = l
66+ }
30 default:
67 default:
31 break
68 break
32 }
69 }
@@ -75,7 +112,7 @@ for target in targets {
75
112
76
113
77
114
78−let tex = TeXer.convert(objects: files.flatMap {$0.value})
115+let tex = TeXer.convert(objects: files.flatMap {$0.value}, with: style)
79
116
80try? tex.write(toFile: output, atomically: true, encoding: .utf8)
117try? tex.write(toFile: output, atomically: true, encoding: .utf8)
81
118