ConwayLife.com

Code: Select all

-- Displays the current pattern's comments in the help window,
-- with clickable links to http sites and pattern files.
-- Author: Andrew Trevorrow (andrew@trevorrow.com)

local g = golly()

--------------------------------------------------------------------------------

function ModifyComments(comments)
    comments = comments:gsub("\n", "<br>\n")
    comments = "\n"..comments -- simplifies the following changes
    
    comments = comments:gsub("\n#N ", "\nName: ", 1)
    comments = comments:gsub("\n#O ", "\nAuthor: ", 1)
    
    -- remove "#C " or "#D " or "# " from start of each line
    -- (#D is used in .mcl files in Patterns/Generations/)
    comments = comments:gsub("\n#[CD] ", "\n")
    comments = comments:gsub("\n# ", "\n")
    -- fix lines with only #C/#D/# (eg. Turmites/AlienCounter.rle)
    comments = comments:gsub("\n#[CD]<br>", "\n<p>\n")
    comments = comments:gsub("\n#<br>", "\n<p>\n")
    
    -- replace space(s) at start of each line with non-breaking spaces
    comments = comments:gsub("\n  ", "\n&nbsp;&nbsp;&nbsp;")
    comments = comments:gsub("\n ", "\n&nbsp;&nbsp;&nbsp;&nbsp;")

    -- this makes tabular info less ugly (esp in osc stamp collection)
    comments = comments:gsub("  ", "\n&nbsp;&nbsp;&nbsp;")
    
    -- escape % for later use as replacement string
    comments = comments:gsub("%%", "%%%%")
    
    -- go thru comments line by line to convert http links and pattern links
    local newlines = {}
    local nextline = comments:gmatch("(.-)\n")
    while true do
        local line = nextline()
        if not line then break end
        local prefix, link, suffix = line:match("^(.*)(http[^ <%),]+)(.+)$")
        if link then
            line = prefix.."<a href=\""..link.."\">"..link.."</a>"..suffix
        else
            prefix, link, suffix = line:match("^(.*)(Patterns/[^ <%)]+)(.+)$")
            if link then
                line = prefix.."<a href=\"open:"..link.."\">"..link.."</a>"..suffix
            end
        end
        newlines[#newlines+1] = line
    end
    
    return table.concat(newlines)
end

--------------------------------------------------------------------------------

function Main()
    local pathname = g.getpath()
    if pathname == "" then g.exit("No current pattern.") end
    
    local comments = g.getinfo()
    if comments == "" then g.exit("No comments in current pattern.") end
    comments = ModifyComments(comments)
    
    -- extract the directory path and file name
    local pathsep = g.getdir("app"):sub(-1)
    local dirpath = pathname:sub(1, pathname:find(pathsep.."[^"..pathsep.."/]*$"))
    local filename = pathname:sub(#dirpath+1)

    -- create a temporary html file
    local htmlname = g.getdir("temp")..filename..".html"
    local f = io.open(htmlname, "w")
    if f then
        local htmldata =
[[
<html>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Pattern Info for FILENAME</title>
<body bgcolor="#FFFFCE">
<p>COMMENTS</p>
</body>
</html>
]]
        htmldata = htmldata:gsub("FILENAME", filename, 1)
        htmldata = htmldata:gsub("COMMENTS", comments, 1)
        f:write(htmldata)
        f:close()
    else
        g.exit("Failed to create temporary html file!")
    end
    g.open(htmlname)
end

--------------------------------------------------------------------------------

Main()

Code: Select all

-- Finds all of Golly's supplied pattern files that have comments with http/pattern links
-- and displays the results in the help window.  Useful for finding broken links.
-- By Andrew Trevorrow (andrew@trevorrow.com).

local g = golly()

local appdir = g.getdir("app")
local pathsep = appdir:sub(-1)
local pattdir = appdir.."Patterns"..pathsep

--------------------------------------------------------------------------------

function Traverse(dir, level, links)
    -- recursively traverse given directory
    local files = g.getfiles(dir)
    if files == nil then
        g.exit("The given directory does not exist:\n"..dir)
    elseif #files == 0 then
        return links
    else
        table.sort(files)
    end
    local tab = "      "
    local indent = ""
    for i = 1, level do indent = indent..tab end
    for _, name in ipairs(files) do
        if name:sub(1,1) == "." then
            -- ignore hidden file
        elseif name:sub(-1) == pathsep then
            -- name is a subdirectory
            links = Traverse(dir..name, level+1, links..indent.."<b>"..name.."</b><br>\n")
        else
            -- name is a file so load it and check if it has any comments
            local fullname = dir..name
            g.open(fullname)
            local comments = g.getinfo()
            if #comments > 0 and (comments:find("http") or comments:find("Patterns/")) then
                -- create an "open:" link to this file
                links = links..indent.."<a href=\"open:"..fullname.."\"><b>"..name.."</b></a><br>\n"
                links = links.."<br>"
                if comments:find("http") then
                    -- add http links
                    local nexthttplink = comments:gmatch("(http[^ <%)\n]+)")
                    while true do
                        local httplink = nexthttplink()
                        if not httplink then break end
                        links = links..indent..tab.."<a href=\""..httplink.."\">"..httplink.."</a><br>\n"
                    end
                end
                if comments:find("Patterns/") then
                    -- add open pattern links
                    local nextpattlink = comments:gmatch("(Patterns/[^ <%)\n]+)")
                    while true do
                        local pattlink = nextpattlink()
                        if not pattlink then break end
                        links = links..indent..tab.."<a href=\"open:"..pattlink.."\">"..pattlink.."</a><br>\n"
                    end
                end
                links = links.."<br>"
            end
        end
    end
    return links
end

--------------------------------------------------------------------------------

function ShowLinks(links)
    -- create a html file with given links and show in help window
    local htmlheader =
        "<html><title>Patterns with links</title>\n"..
        "<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n"..
        "<body bgcolor=\"#FFFFCE\"><p>\n"
    local htmlfooter = "</body></html>"

    -- create the html data in a temporary file
    local htmlfile = g.getdir("temp").."links.html"
    local f = io.open(htmlfile,"w")
    if not f then
        g.exit("Failed to create file:\n"..htmlfile)
    end
    f:write(htmlheader)
    f:write("<b>"..pattdir.."</b><br>\n")
    f:write(links)
    f:write(htmlfooter)
    f:close()
    g.open(htmlfile)
    g.show("")
end

--------------------------------------------------------------------------------

g.addlayer()
ShowLinks(Traverse(pattdir, 1, ""))
g.dellayer()