Skip to content

Commit c6ce414

Browse files
author
johtela
committed
Initial commit
0 parents  commit c6ce414

File tree

211 files changed

+25872
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

211 files changed

+25872
-0
lines changed

‎.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
################################################################################
2+
# This .gitignore file was automatically created by Microsoft(R) Visual Studio.
3+
################################################################################
4+
5+
/.vs
6+
/bin
7+
/obj
8+
/LiterateProgramming.csproj.user
9+
/packages
10+
/CSWeave.Theme/bin
11+
/CSWeave.Theme/obj
12+
/Themes/DefaultTheme/bin
13+
/Themes/DefaultTheme/obj
14+
*.swp
15+
*.zip

‎CSWeave.Theme/CSWeave.Theme.csproj

+51
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<Project ToolsVersion="14.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
3+
<Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
4+
<PropertyGroup>
5+
<Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
6+
<Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
7+
<ProjectGuid>{0E9474F8-0265-4EFF-9522-A667D192A1FD}</ProjectGuid>
8+
<OutputType>Library</OutputType>
9+
<AppDesignerFolder>Properties</AppDesignerFolder>
10+
<RootNamespace>CSWeave.Theme</RootNamespace>
11+
<AssemblyName>CSWeave.Theme</AssemblyName>
12+
<TargetFrameworkVersion>v4.6.1</TargetFrameworkVersion>
13+
<FileAlignment>512</FileAlignment>
14+
</PropertyGroup>
15+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
16+
<DebugSymbols>true</DebugSymbols>
17+
<DebugType>full</DebugType>
18+
<Optimize>false</Optimize>
19+
<OutputPath>bin\Debug\</OutputPath>
20+
<DefineConstants>DEBUG;TRACE</DefineConstants>
21+
<ErrorReport>prompt</ErrorReport>
22+
<WarningLevel>4</WarningLevel>
23+
</PropertyGroup>
24+
<PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
25+
<DebugType>pdbonly</DebugType>
26+
<Optimize>true</Optimize>
27+
<OutputPath>bin\Release\</OutputPath>
28+
<DefineConstants>TRACE</DefineConstants>
29+
<ErrorReport>prompt</ErrorReport>
30+
<WarningLevel>4</WarningLevel>
31+
</PropertyGroup>
32+
<ItemGroup>
33+
<Reference Include="System" />
34+
<Reference Include="System.Core" />
35+
</ItemGroup>
36+
<ItemGroup>
37+
<Compile Include="DirHelpers.cs" />
38+
<Compile Include="PageParams.cs" />
39+
<Compile Include="Properties\AssemblyInfo.cs" />
40+
<Compile Include="Theme.cs" />
41+
<Compile Include="Toc.cs" />
42+
</ItemGroup>
43+
<Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
44+
<!-- To modify your build process, add your task inside one of the targets below and uncomment it.
45+
Other similar extension points exist, see Microsoft.Common.targets.
46+
<Target Name="BeforeBuild">
47+
</Target>
48+
<Target Name="AfterBuild">
49+
</Target>
50+
-->
51+
</Project>

‎CSWeave.Theme/DirHelpers.cs

+82
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
/*
2+
# Directory Utilities
3+
4+
This class contains utility functions needed by theme assemblies as well as the
5+
`csweave` tool. It is an assorted collection static functions, mostly related to
6+
directory manipulation, that do not logically belong to any other class.
7+
*/
8+
namespace CSWeave.Theme
9+
{
10+
using System.IO;
11+
using System.Linq;
12+
13+
public static class DirHelpers
14+
{
15+
/*
16+
## Miscellaneous Methods
17+
18+
Testing if a value is in a specified set is usually done by a long and
19+
repetitive `if` statement of the form:
20+
21+
if (<variable> == <value1> ||
22+
<variable> == <value2> ||
23+
<variable> == <value3> ||
24+
...)
25+
26+
By using the extension method below the test simplifies to:
27+
28+
if (<variable>.In (<value1>, <value2>, <value3>, ...))
29+
*/
30+
public static bool In<T> (this T obj, params T[] values)
31+
{
32+
return values.Contains (obj);
33+
}
34+
/*
35+
## Directory Related Methods
36+
37+
The following method copies all subdirectories of a given input directory
38+
to a target directory. **Note** that it only copies the directory structure,
39+
not the files inside those directories.
40+
41+
You can specify a glob filter for the input directories. Only directories
42+
with names matching the filter will be copied. If you want all the
43+
directories copied, give `*` as the filter.
44+
45+
You can also specify with the `recurse` parameter whether the whole
46+
directory tree is copied, or just the top level directories.
47+
*/
48+
public static void CopySubDirectories (string inputRoot, string outputRoot,
49+
string filter, bool recurse)
50+
{
51+
foreach (string subDir in Directory.GetDirectories (inputRoot, filter,
52+
GetSearchOption (recurse)))
53+
EnsureExists (subDir.Replace (inputRoot, outputRoot));
54+
}
55+
/*
56+
The method below is used to make sure that a given directory exists. Most
57+
of the file operations fail, if a target directory does not exist.
58+
*/
59+
public static void EnsureExists (string dir)
60+
{
61+
if (!Directory.Exists (dir))
62+
Directory.CreateDirectory (dir);
63+
}
64+
/*
65+
The following methods are just shorthands for GetFiles and Copy methods
66+
defined in the System.IO namespace. They define a more convenient
67+
signature for the wrapped methods.
68+
*/
69+
public static string[] Dir (string path, string filter, bool recurse) =>
70+
Directory.GetFiles (path, filter, GetSearchOption (recurse));
71+
72+
public static void Copy (string file, string targetFolder, bool overwrite)
73+
{
74+
File.Copy (file, Path.Combine (targetFolder, Path.GetFileName (file)), overwrite);
75+
}
76+
77+
public static SearchOption GetSearchOption (bool recurse) =>
78+
recurse ?
79+
SearchOption.AllDirectories :
80+
SearchOption.TopDirectoryOnly;
81+
}
82+
}

‎CSWeave.Theme/PageParams.cs

+134
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
/*
2+
# Page Parameters
3+
4+
All the data `csweave` will pass to the theme is contained inside a
5+
PageParams object. This class defines the built-in parameters that are
6+
always available, and the custom parameters specified in front matter.
7+
*/
8+
namespace CSWeave.Theme
9+
{
10+
using System.Collections.Generic;
11+
using System.IO;
12+
13+
public class PageParams
14+
{
15+
/*
16+
## Custom Parameters
17+
18+
You can specify any parameters inside front matter. How these will
19+
be used is up to the theme. The parameters are simple key-value pairs
20+
with string both as the key and value type. The parameters are stored
21+
in a dictionary that is initialized when a PageParams object is created.
22+
*/
23+
private Dictionary<string, string> _parameters;
24+
25+
public PageParams ()
26+
{
27+
_parameters = new Dictionary<string, string> ();
28+
}
29+
/*
30+
The parameters are converted to lowercase before they are added to the
31+
dictionary. Parameter names are case-insensitive, so we need to do this
32+
in all the methods accessing the dictionary. If a parameter with the
33+
same name already exists in the dictionary, its value is updated.
34+
*/
35+
public void Add (string name, string value)
36+
{
37+
name = name.ToLower ();
38+
if (_parameters.ContainsKey (name))
39+
_parameters[name] = value;
40+
else
41+
_parameters.Add (name, value);
42+
}
43+
/*
44+
Removing a parameter is also possible, although themes should not
45+
generally do so.
46+
*/
47+
public void Remove (string name)
48+
{
49+
_parameters.Remove (name.ToLower ());
50+
}
51+
/*
52+
Two indexer methods can be used to access the custom parameters. The
53+
first one takes two arguments: name and default value. If a parameter
54+
with a given name is not found, the default value is returned.
55+
*/
56+
public string this[string name, string defaultValue]
57+
{
58+
get
59+
{
60+
string result;
61+
return _parameters.TryGetValue (name.ToLower (), out result) ?
62+
result : defaultValue;
63+
}
64+
}
65+
/*
66+
The second version takes just name of the parameter, and returns it back,
67+
if the parameter is not found.
68+
*/
69+
public string this[string name] =>
70+
this[name, name];
71+
/*
72+
## Built-in Properties
73+
74+
The rest of the properties defined in the PageParams class are updated
75+
for each generated page. These are page-level parameters which are always
76+
available.
77+
78+
The Root property gives the relative path from the page location to the
79+
root directory of the website. For example, if the page we are generating
80+
resides under directory `source\code\`, then Root would contain path
81+
`..\..\`. Say you want to add a link to another page which resides under
82+
directory `doc\`. Now you can to refer to it by adding the value of the
83+
Root property at the beginning of the path. The resulting path would be
84+
`..\..\doc\`.
85+
86+
So, the Root property allows us to create relative links between pages
87+
that work regardless of where the site resides on disk. This is
88+
quite handy since now the links work correctly when pages are viewed
89+
locally from disk as well as when they are accessed from a web server.
90+
*/
91+
public string Root { get; set; }
92+
/*
93+
The name of the currently processed file is stored in the property
94+
below. The name does not include a file extension.
95+
*/
96+
public string Filename { get; set; }
97+
/*
98+
Perhaps the most important data passed to the theme is the contents
99+
of the page which is provided in the property below. The property
100+
contains the documentation extracted from the source file in HTML
101+
format. Typically the theme will just insert this in the appropriate
102+
place on a page.
103+
*/
104+
public string Contents { get; set; }
105+
/*
106+
### TOC Related Properties
107+
108+
The table of contents object is accessible through the Toc property.
109+
This object is always initialized, even when the user does not provide
110+
a TOC file. In that case the TOC is empty, and there are no sections
111+
in it.
112+
*/
113+
public Toc Toc { get; set; }
114+
/*
115+
When a TOC file is provided, and the current page can be found in it,
116+
then the following property contains a reference to the Section object
117+
we are on currently. This information can be used to highlight which
118+
section in the TOC we are viewing.
119+
*/
120+
public Section CurrentSection { get; set; }
121+
/*
122+
The SectionPath helper function returns the relative path to section in
123+
the TOC from the current page. It is handy in generating links to TOC.
124+
The method also changes the source file path to a relative URL by
125+
changing the extension to "html" and replacing backslashes with
126+
forward slashes.
127+
*/
128+
public string SectionPath (Section entry) =>
129+
entry.File == null ?
130+
null :
131+
Path.Combine (Root, Path.ChangeExtension (entry.File, "html"))
132+
.Replace ('\\', '/');
133+
}
134+
}

‎CSWeave.Theme/Properties/AssemblyInfo.cs

+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
using System.Reflection;
2+
3+
// General Information about an assembly is controlled through the following
4+
// set of attributes. Change these attribute values to modify the information
5+
// associated with an assembly.
6+
[assembly: AssemblyTitle ("csweave - Literate Programming Tool for C#")]
7+
[assembly: AssemblyCopyright ("Copyright (c) 2017 Tommi Johtela")]
8+
9+
// Version information for an assembly consists of the following four values:
10+
//
11+
// Major Version
12+
// Minor Version
13+
// Build Number
14+
// Revision
15+
//
16+
// You can specify all the values or you can default the Build and Revision Numbers
17+
// by using the '*' as shown below:
18+
// [assembly: AssemblyVersion("1.0.*")]
19+
[assembly: AssemblyVersion ("1.0.0.0")]

‎CSWeave.Theme/Theme.cs

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
/*
2+
# Theme Base Class
3+
4+
Theme assemblies have to include a class which inherits from the Theme class
5+
and implements a few abstract methods. The Theme base class defines the
6+
interface through which the HtmlGenerator class can use the theme.
7+
*/
8+
namespace CSWeave.Theme
9+
{
10+
using System.IO;
11+
12+
public abstract class Theme
13+
{
14+
/*
15+
The first method that needs to be implemented returns the list of page
16+
templates available in the theme. A theme can have as many templates
17+
as it likes, but it must define at least one: the default template. The
18+
name of the default template should be "default".
19+
*/
20+
public abstract string[] AvalailablePageTemplates { get; }
21+
/*
22+
The second method to implement performs the rendering of the page using
23+
the template specified. The default template is used, if `pageTemplate`
24+
is `null`. Page parameters are set by the HtmlGerenator and passed to
25+
the render method.
26+
*/
27+
public abstract string RenderPage (string pageTemplate, PageParams pageParams);
28+
/*
29+
Theme class provides a default implementation for copying the auxiliary
30+
files needed by the HTML pages. The default implementation copies all
31+
files under the theme directory except the ones with extension ".dll" or
32+
".pdb".
33+
*/
34+
public virtual void CopyAuxiliaryFiles (string themeDir, string outputDir)
35+
{
36+
DirHelpers.CopySubDirectories (themeDir, outputDir, "*", true);
37+
foreach (var file in DirHelpers.Dir (themeDir, "*", true))
38+
if (!Path.GetExtension (file).In (".dll", ".pdb"))
39+
File.Copy (file, file.Replace (themeDir, outputDir), true);
40+
}
41+
}
42+
}

0 commit comments

Comments
 (0)