LintProject - Improving the Usability of PC-Lint with Visual C++ Solutions and Projects

/************************************************************************
 *
 *  Description : CVc7ProjectFileReaderImpl - implementation class to read
 *                Visual C# project files.
 *
 *     (c) Copyright 1996-2008 by Anna-Jayne Metcalfe (anna@riverblade.co.uk)
 *     and Beth Mackenzie (beth@riverblade.co.uk) / Riverblade Limited
 *
 *  Licence Terms:
 *
 *     This code may be freely reused, subject to the licence terms below.
 *     Please do let us know of any bugs you find or improvements you make,
 *     so that we can pass them on to the rest of the development community.
 *
 *     This code is free software; you can redistribute it and/or
 *     modify it under the terms of the Code Project Open License (CPOL)
 *     version 1.0 (http://www.codeproject.com/info/cpol10.aspx).
 *
 *     This code 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
 *     Code Project Open Licence for further details.
 *
 ************************************************************************
 *    $Archive: /Projects/Applications/LintProject/Development/Shared/CSharpProjectFileReaderImpl.h $
 *   $Revision: 4 $
 *       $Date: 22/02/08 12:57 $
 *     $Author: Anna $
 * 
 * $Nokeywords: $
 ************************************************************************/

/// \file	
/// \brief CProjectFileReader implementation class.

#pragma once

#include "ProjectFileReaderImpl.h"


namespace Riverblade
{
	namespace Libraries
	{
		namespace AddInSolutionModel
		{
			/// \brief Implementation class to read Visual C# project files
			///
			class CCSharpProjectFileReaderImpl : public CProjectFileReaderImpl
			{
				public:
					/// \brief Default constructor.
					///
					CCSharpProjectFileReaderImpl(void)
						:	CProjectFileReaderImpl()
					{
					}


					/// \brief Class destructor.
					///
					virtual ~CCSharpProjectFileReaderImpl(void)
					{
					}


					/// \brief Parse the given Visual C# 7.0/7.1/8.0/9.0 project file contents.
					/// 
					/// \param	sFileText			The text of the project file.
					/// \return						\em true if the contents were parsed successfully;
					///								\em false otherwise.
					///
					virtual bool Parse(const CString& sFileText)
					{
						USES_CONVERSION;

						MSXML2::IXMLDOMDocumentPtr ptrDOMDoc;

						// Create empty DOM
						const HRESULT hr = ptrDOMDoc.CreateInstance("Msxml2.DOMDocument.3.0");
						ATLASSERT(SUCCEEDED(hr) );
						DBG_UNREFERENCED_LOCAL_VARIABLE(hr);

						ATLVERIFY(VARIANT_FALSE != ptrDOMDoc->loadXML(T2COLE(sFileText) ) );

						const MSXML2::IXMLDOMElementPtr ptrSettingsElement = ptrDOMDoc->selectSingleNode(L"VisualStudioProject/CSHARP/Build/Settings");

						m_sProjectName = OLE2CT(ptrSettingsElement->getAttribute(L"AssemblyName").bstrVal);

						// Read files
						const MSXML2::IXMLDOMNodeListPtr ptrFileNodes = ptrDOMDoc->selectNodes(L"VisualStudioProject/CSHARP/Files/Include/File");

						long nCount = ptrFileNodes->Getlength();

						for (long n = 0; n < nCount; ++n)
						{
							const MSXML2::IXMLDOMElementPtr ptrFileElement = ptrFileNodes->Getitem(n);
							
							const CString sRelativePathName = OLE2CT(ptrFileElement->getAttribute(L"RelPath").bstrVal);

							const CString sPathName = GetPathName(sRelativePathName);

							(void)m_arrayFiles.Add(sPathName);
						}

						// Read configurations
						const MSXML2::IXMLDOMNodeListPtr ptrConfigNodes = ptrDOMDoc->selectNodes(L"VisualStudioProject/CSHARP/Build/Settings/Config");

						nCount = ptrConfigNodes->Getlength();

						for (long n = 0; n < nCount; ++n)
						{
							const MSXML2::IXMLDOMElementPtr ptrConfigElement = ptrConfigNodes->Getitem(n);

							const CString sConfigName = OLE2CT(ptrConfigElement->getAttribute(L"Name").bstrVal);

							// Add an empty object, as it doesn't include anything relevant to C# - all we
							// care about are the names of the configurations.
							CProjectConfiguration info;
							m_mapConfigToSettings[sConfigName] = info;

							(void)m_mapAvailableConfigurations.SetAt(sConfigName, _T("") );		// LEGACY
						}
						return true;
					}


					/// \brief Return the "configuration string" for a given configuration within the project.
					///
					/// \param	sConfig						The name of the configuration for which the configuration string should be returned.
					/// \return								The corresponding configuration string, or an empty string if the configuration name
					///										is not recognised.
					///
					virtual CString GetConfigurationString(const CString& sConfig) const
					{
						CString sUnused;
						if (m_mapAvailableConfigurations.Lookup(sConfig, sUnused) )
						{
							return sConfig;
						}
						return _T("");
					}

			};


		};	// namespace AddInSolutionModel
	};	// namespace Libraries
};	//namespace Riverblade