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

/************************************************************************
 *
 *  Description : CSolutionLintAnalyser - class for analysing Visual C++
 *                solutions (.sln) and workspaces (.dsw) using the
 *                PC-Lint code analysis tool.
 *
 *     (c) Copyright 2004-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/SolutionLintAnalyser.h $
 *   $Revision: 14 $
 *       $Date: 9/04/08 9:45 $
 *     $Author: Anna $
 * 
 * $Nokeywords: $
 ************************************************************************/

/// \file	
/// \brief CSolutionLintAnalyser class declaration.

#pragma once


#include "ProjectLintAnalyser.h"


//lint -esym(1712, CSolutionLintAnalyser)	(Information -- default constructor not defined for class)
class CSolutionLintAnalyser
{
public:
			CSolutionLintAnalyser(	const CString& sSolutionFilePathName,
									const CString& sResultsFileFolder,
									const CString& sLintConfigFile,
									const CString& sAdditionalProjectParams,
									const CString& sAdditionalParams,
									const CString& sConfiguration);

			CSolutionLintAnalyser(	const CString& sSolutionFilePathName,
									const CString& sResultsFileFolder,
									const CString& sLintConfigFile,
									const CString& sAdditionalProjectParams,
									const CString& sAdditionalParams,
									const CString& sConfiguration,
		                            const std::set<CString>& setExcludedProjects);


	virtual ~CSolutionLintAnalyser(void);


// Data Members
protected:
			CString					m_sLintFolder;
			CString					m_sSolutionFilePathName;
			CString					m_sSolutionFileFolder;
			CString					m_sSolutionName;
			CString					m_sResultsFileFolder;
			CString					m_sResultsIndexFilePathName;
			CString					m_sLintConfigFile;
			CString					m_sAdditionalProjectParams;
			CString					m_sAdditionalParams;
			CString					m_sConfiguration;
			std::set<CString>		m_setExcludedProjects;
			bool					m_bShowHtml;

			COleDateTime			m_timeStarted;
			int						m_nWarningCount;
			CString					m_sElapsedTime;

			CAtlArray<CProjectLintAnalyser>
									m_arrayProjectResults;


// Virtual overrides
protected:
	virtual	bool					PostWriteResultsFile(const CString& sResultsIndexFilePathName);


// Operations
public:
			bool					SetLintFolder(const CString& sFolder);

			bool					ShowHtml(bool bShowHtml);

			INT_PTR					GetConfigurations(CAtlArray<CString>& rarrayConfigurations) const;

			int						GetWarningCount(void) const;

			CString					GetResultsIndexFilePathName(void) const;

			bool					Analyse(void);

			bool					WriteResultsIndexFile(void);


// Implementation
private:
			bool					WriteXml(			const CString& sPathName,
														CString* psMsg = NULL);

			bool					WriteReport(		const CString& sPathName,
														const CString& sXslStyleSheetText,
														CString* psMsg = NULL);

			CString					GenerateReportText(	const CString& sXslStyleSheetText,
														CString* psMsg = NULL) const;

			CString					GenerateReportText(	const MSXML2::IXMLDOMDocumentPtr& ptrXmlDoc,
														const MSXML2::IXMLDOMDocumentPtr& ptrXslStyleSheetDoc,
														CString* psMsg = NULL) const;

			HRESULT					GenerateXml(		const MSXML2::IXMLDOMDocumentPtr& ptrDOMDoc,
														CString* psMsg = NULL) const;

			HRESULT					GenerateXml(		const MSXML2::IXMLDOMDocumentPtr& ptrDOMDoc,
														const MSXML2::IXMLDOMElementPtr& pParentElement,
														CString* psMsg = NULL) const;

			bool					SetEnvironmentVariables(void);
			bool					ResetEnvironmentVariables(void);
};