FilesExpand file tree

 develop

/

DocumentWriter.cs

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

230 lines (187 loc) · 8.32 KB

 develop

/

DocumentWriter.cs

Copy path

Top

File metadata and controls

• Code
• Blame

230 lines (187 loc) · 8.32 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

/*----------------------------------------------------------

This Source Code Form is subject to the terms of the

Mozilla Public License, v.2.0. If a copy of the MPL

was not distributed with this file, You can obtain one

at http://mozilla.org/MPL/2.0/.

----------------------------------------------------------*/

using System;

using System.Collections.Generic;

using System.IO;

using System.Text;

using OneScript.Localization;

using OneScriptDocumenter.Model;

using OneScriptDocumenter.Secondary;

namespace OneScriptDocumenter.Cli

{

public class DocumentWriter : BaseModelVisitor

{

private readonly string _baseDir;

private MarkdownWriter _writer;

public DocumentWriter(string baseDir)

{

_baseDir = baseDir;

}

protected override void VisitDocument(IDocument document)

{

CreateDocumentFile(_baseDir, document);

}

private void CreateDocumentFile(string outputDir, IDocument document)

{

var fileName = ReferenceFactory.GetBslNameForAnnotatedObject(document.Owner) + ".md";

using var writer = MarkdownWriter.OpenFile(Path.Combine(outputDir, fileName));

switch (document)

{

case GlobalContextModel globalContext:

WriteGlobalContext(writer, globalContext);

break;

case ClassModel classModel:

WriteClass(writer, classModel);

break;

case EnumModel enumModel:

WriteEnum(writer, enumModel);

break;

default:

throw new ArgumentOutOfRangeException();

}

}

private void WriteEnum(MarkdownWriter writer, EnumModel model)

{

WriteOutlineOptions(writer);

writer.Header1(BiString(model.Name));

writer.Paragraph(model.Description);

writer.Header2("Элементы");

foreach (var itemModel in model.Items)

{

writer.Header3(BiString(itemModel.Name));

writer.Paragraph(itemModel.Description);

}

}

private void WriteClass(MarkdownWriter writer, ClassModel model)

{

WriteOutlineOptions(writer);

writer.Header1(BiString(model.Name));

writer.Paragraph(model.Description);

WriteProperties(writer, model.Properties);

WriteMethods(writer, model.Methods);

WriteConstructors(writer, model.Constructors);

}

private void WriteGlobalContext(MarkdownWriter writer, GlobalContextModel model)

{

WriteOutlineOptions(writer);

writer.Header1(model.Title);

writer.Paragraph(model.Description);

WriteProperties(writer, model.Properties);

WriteMethods(writer, model.Methods);

}

private void WriteProperties(MarkdownWriter writer, IList<PropertyModel> propModels)

{

if (propModels == null || propModels.Count == 0)

return;

writer.Header2("Свойства");

foreach (var propModel in propModels)

{

writer.Header3(BiString(propModel.Name));

writer.BeginList(true);

writer.ListItem("Чтение: " + (propModel.CanRead ? "Да" : "Нет"));

writer.ListItem("Запись: " + (propModel.CanWrite ? "Да" : "Нет"));

writer.EndList();

if (!string.IsNullOrEmpty(propModel.Returns))

writer.Paragraph("**Тип значения:** " + propModel.Returns);

writer.Paragraph(propModel.Description);

if (!string.IsNullOrEmpty(propModel.Example))

{

writer.Header4("Пример");

writer.WriteCode(propModel.Example);

}

}

}

private void WriteMethods(MarkdownWriter writer, IList<MethodModel> methModels)

{

if (methModels == null || methModels.Count == 0)

return;

writer.Header2("Методы");

foreach (var model in methModels)

{

writer.Header3(BiString(model.Name));

writer.Paragraph(model.Description);

if (model.Parameters != null && model.Parameters.Count > 0)

{

writer.Header4("Параметры");

writer.BeginList(true);

foreach (var parameterModel in model.Parameters)

{

var itemBuilder = new StringBuilder();

itemBuilder.Append($"**{parameterModel.Name}**: {parameterModel.Description}");

if (parameterModel.IsOptional)

{

itemBuilder.Append(" *Необязательный*. ");

if (!string.IsNullOrEmpty(parameterModel.DefaultValue))

itemBuilder.Append($"Значение по умолчанию: {parameterModel.DefaultValue}");

}

writer.ListItem(itemBuilder.ToString());

}

writer.EndList();

}

if (!string.IsNullOrEmpty(model.ReturnTypeDocumentation))

{

writer.Header4("Возвращаемое значение");

writer.Paragraph(model.ReturnTypeDocumentation);

}

if (!string.IsNullOrEmpty(model.Example))

{

writer.Header4("Пример");

writer.WriteCode(model.Example);

}

}

}

private void WriteConstructors(MarkdownWriter writer, IList<MethodModel> methModels)

{

if (methModels == null || methModels.Count == 0)

return;

writer.Header2("Конструкторы");

foreach (var model in methModels)

{

writer.Header3(model.Title);

writer.Paragraph(model.Description);

if (model.Parameters != null && model.Parameters.Count > 0)

{

writer.Header4("Параметры");

writer.BeginList(true);

foreach (var parameterModel in model.Parameters)

{

var itemBuilder = new StringBuilder();

itemBuilder.Append($"**{parameterModel.Name}**: {parameterModel.Description}");

if (parameterModel.IsOptional)

{

itemBuilder.Append(" *Необязательный*. ");

if (!string.IsNullOrEmpty(parameterModel.DefaultValue))

itemBuilder.Append($"Значение по умолчанию: {parameterModel.DefaultValue}");

}

writer.ListItem(itemBuilder.ToString());

}

writer.EndList();

}

if (!string.IsNullOrEmpty(model.ReturnTypeDocumentation))

{

writer.Header4("Возвращаемое значение");

writer.Paragraph(model.ReturnTypeDocumentation);

}

if (!string.IsNullOrEmpty(model.Example))

{

writer.Header4("Пример");

writer.WriteCode(model.Example);

}

}

}

private static void WriteOutlineOptions(MarkdownWriter writer)

{

writer.Raw("---\n" +

"outline: [2, 3]\n" +

"---\n");

}

private static string BiString(BilingualString bi) =>

bi.English != null ?

$"{bi.Russian} / {bi.English}"

: bi.Russian;

}

}