CSprojFile.lua

-- Class and utility functions for C# project files (*.csproj)
-- Copyright 2012,2013 Green Code LLC
--
-- This library is free software; you can redistribute it and/or
-- modify it under the terms of the GNU Lesser General Public
-- License as published by the Free Software Foundation; either
-- version 2.1 of the License, or (at your option) any later version.
-- 
-- This library is distributed in the hope that it will be useful,
-- but WITHOUT ANY WARRANTY; without even the implied warranty of
-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-- GNU Lesser General Public License for more details.
-- 
-- You should have received a copy of the GNU Lesser General Public
-- License along with this library; if not, see
-- <http://www.gnu.org/licenses/>.
--
-- Contributors:
--   James Domingo, Green Code LLC
-- ==========================================================================

-- Release history:
--   2012-08-26 : Initial release
--   2012-09-02 : Changed license from BSD to LGPL.
--                Improved documentation in comments.
--                Added removeFrameworkProfile function.
--   2013-03-07 : Added enableXMLdocumentation function.

-- ==========================================================================

-- A class that represents a C# project's .csproj file.
--
-- For simplicity, the XML in the file isn't parsed.  Instead, the lines in
-- file are stored (assumes the file is formatted in line-oriented way).

require 'class'
CSprojFile = class()

function CSprojFile:__init(proj)
  self.project = proj
  self.name = proj.name .. ".csproj"
  self.absDir = proj.location
  self.absPath = path.join(self.absDir, self.name)
  self.relDir = path.getrelative(os.getcwd(), proj.location)
  self.relPath = path.join(self.relDir, self.name)
  self.lines = nil
end

function CSprojFile:readLines()
  self.lines = { }
  for line in io.lines(self.absPath) do
    table.insert(self.lines, line)
  end
end

-- Write the modified lines out to the .csproj file.
-- Return true if successful; otherwise, return (false, error message)
function CSprojFile:writeLines()
  local outFile, errMessage = io.open(self.absPath, "w")
  if not outFile then
    return false, string.format("Cannot open \"%s\" for writing: %s",
                                self.relPath, errMessage)
  end
  for _, line in ipairs(self.lines) do
    outFile:write(line .. "\n")
  end
  outFile:close()
  return true
end

-- ==========================================================================

-- MonoDevelop cannot find referenced assemblies which have paths in their
-- Include attribute (see https://bugzilla.xamarin.com/show_bug.cgi?id=6008).

-- This function scans the lines of a *.csproj file for Reference elements
-- with a path in their Include attribute.  For each such Reference, the
-- path is removed from its Include attribute, and inserted into a new
-- HintPath element.  For example, this line:
--
--    <Reference Include="some\path\to\Example.Assembly.dll" />
--
-- is replaced with 3 lines:
--
--    <Reference Include="Example.Assembly">
--      <HintPath>some\path\to\Example.Assembly.dll</HintPath>
--    </Reference>

function adjustReferencePaths(csprojFile)
  local lines = { }
  for _, line in ipairs(csprojFile.lines) do
    -- Look for <Reference Include="some\path\to\Example.Assembly.dll" />
    local pattern = "(%s*)<Reference%s+Include=\"(.*)\\(.+)\""
    local indent, path, fileName = string.match(line, pattern)
    if path then
      fileNoExt = string.gsub(fileName, "\.[^.]+$", "")
      local newLines = {
        string.format("<Reference Include=\"%s\">", fileNoExt) ,
        string.format("  <HintPath>%s\\%s</HintPath>", path, fileName) ,
	              "</Reference>"
      }
      for _, newLine in ipairs(newLines) do
        table.insert(lines, indent .. newLine)
      end
    else
      table.insert(lines, line)
    end
  end -- for each line in file
  csprojFile.lines = lines
end

-- ==========================================================================

-- This function adds a new line with the target framework, right after the
-- line with the assembly's name:
--
--    <AssemblyName>Landis.Core</AssemblyName>
--    <TargetFrameworkVersion>v3.5</TargetFrameworkVersion>   <-- new line
--
-- This is only needed in Premake 4.3 because the framework function is
-- broken in that version.  For example:
--
--    if _PREMAKE_VERSION == "4.3" then
--      -- In 4.3, the "framework" function doesn't work
--      addFramework(csprojFile)
--      print("  <TargetFrameworkVersion> element added to the project's properties")
--    end

function addFramework(csprojFile)
  local framework = csprojFile.project.framework or solution().framework
  for i, line in ipairs(csprojFile.lines) do
    -- Look for <AssemblyName>Example.Assembly</AssemblyName>
    local pattern = "^(%s*)<AssemblyName>"
    local indent = string.match(line, pattern)
    if indent then
      local frameworkLine = string.format(
        "%s<TargetFrameworkVersion>v%s</TargetFrameworkVersion>",
        indent, framework)
      table.insert(csprojFile.lines, i + 1, frameworkLine)
      break
    end
  end -- for each line in file
end

-- ==========================================================================

-- This function removes the <TargetFrameworkProfile> element from a project
-- file, if the element is present.
--
-- Premake 4.4(beta 4) sets this element to the "Client" profile.  The
-- section "Selecting a Target Framework" on the "MSBuild MultiTargeting"
-- page:
--
--   http://msdn.microsoft.com/en-us/library/ee395432%28v=vs.100%29.aspx
--
-- states that if <TargetFrameworkProfile> is not present, the full framework
-- is targeted.

function removeFrameworkProfile(csprojFile)
  for i, line in ipairs(csprojFile.lines) do
    local pattern = "^%s*<TargetFrameworkProfile>"
    if string.match(line, pattern) then
      table.remove(csprojFile.lines, i)
      break
    end
  end -- for each line in file
end

-- ==========================================================================

-- This function enables the generation of XML documentation file for a
-- project.
--
-- VC# 2010 requires the developer to specify the path to the XML file.  The
-- path is stored in the <DocumentationFile> element of each configuration's
-- property group.
--
-- MonoDevelop 3.0 just allows the developer to enable the generation of the
-- XML file.  It stores a boolean value in the <GenerateDocumentation>
-- element of a configuration's property group.
--
-- To work with multiple IDEs, this function inserts both elements into each
-- configuration's property group right after the <OutputPath> element:
--
--    <OutputPath>bin\Debug</OutputPath>
--    <DocumentationFile>bin\Debug\MyAssembly.xml</DocumentationFile>   <-- new
--    <GenerateDocumentation>true</GenerateDocumentation>               <-- new

function enableXMLdocumentation(csprojFile)
  local lookingFor = "AssemblyName"
  local AssemblyNamePattern = "%s*<AssemblyName>(.*)</AssemblyName>"
  local assemblyName = nil
  local OutputPathPattern   = "(%s*)<OutputPath>(.*)</OutputPath>"
  local ItemGroupPattern    = "%s*<ItemGroup>"
  local lines = { }

  for _, line in ipairs(csprojFile.lines) do
    -- Copy the current line
    table.insert(lines, line)

    -- Check if the current line is one we're looking for
    if lookingFor == "AssemblyName" then
      assemblyName = string.match(line, AssemblyNamePattern)
      if assemblyName then
        lookingFor = "OutputPath"
      end
    elseif lookingFor == "OutputPath" then
      local indent, outputPath = string.match(line, OutputPathPattern)
      if outputPath then
        local docFile = string.format("%s\\%s.xml", outputPath, assemblyName)
        local newLines = {
          "<DocumentationFile>" .. docFile .. "</DocumentationFile>" ,
  	  "<GenerateDocumentation>true</GenerateDocumentation>"
        }
        for _, newLine in ipairs(newLines) do
          table.insert(lines, indent .. newLine)
        end
      elseif string.match(line, ItemGroupPattern) then
        -- no more property groups for configurations
        lookingFor = nil
      end
    end
  end -- for each line in file

  csprojFile.lines = lines
end