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

/************************************************************************
 *
 *  Description : CSolutionFileReader - class to parse Visual Studio
 *                solution or workspace files.
 *
 *     (c) Copyright 2000-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/SolutionFileReader.cpp $
 *   $Revision: 9 $
 *       $Date: 22/02/08 20:58 $
 *     $Author: Anna $
 * 
 * $Nokeywords: $
 ************************************************************************/

/// \file	
/// \brief CSolutionFileReader implementation.

#include "StdAfx.h"

#include "SolutionFileReaderImpl.h"
#include "Vs6WorkspaceFileReaderImpl.h"
#include "Vs7SolutionFileReaderImpl.h"
#include "SolutionFileReader.h"



namespace Riverblade
{
	namespace Libraries
	{
		namespace AddInSolutionModel
		{
			////////////////////////////////////////////////////////////////////////////////
			// CSolutionFileReader construction/destruction
			//
			/// \brief Default constructor
			///
			CSolutionFileReader::CSolutionFileReader(void)
				:	m_pImpl(NULL)
			{
			}


			/// \brief Class destructor
			///
			CSolutionFileReader::~CSolutionFileReader(void)
			{
				try
				{
					if (NULL != m_pImpl)
					{
						delete m_pImpl;
					}
				}
				catch (...)
				{
					ATLASSERT(!"Unexpected exception caught in CSolutionFileReader destructor");
				}
				m_pImpl = NULL;
			}


			////////////////////////////////////////////////////////////////////////////////
			// CSolutionFileReader operations
			//
			/// \brief Read and parse the solution/workspace file with the given pathname.
			///
			/// Note that the format of the solution/workspace file will be detected automatically,
			/// and the appropriate implementation class created.
			/// 
			/// \param	sPathName			The pathname of the solution/workspace file
			/// \return						\em true if the solution/workspace file was parsed successfully;
			///								\em false otherwise.
			///
			bool CSolutionFileReader::Read(const CString& sPathName)
			{
				Utils::CSplitPath splitpath(sPathName);

				CString sExt = splitpath.GetExtension();
				(void)sExt.MakeLower();

				if (0 == sExt.CompareNoCase( _T(".sln") ) )
				{
					m_pImpl = new CVs7SolutionFileReaderImpl();
				}
				else
				{
					m_pImpl = new CVs6WorkspaceFileReaderImpl();
				}

				ATLASSERT(NULL != m_pImpl);
				if (NULL != m_pImpl)			//lint !e774	(Information -- Boolean within 'if' always evaluates to True)
				{
					return m_pImpl->Read(sPathName);
				}
				return false;
			}


			/// \brief Retrieve the pathnames of the project files within the solution/workspace.
			///
			/// \param	rarrayProjectFilePathNames		A reference to a CAtlArray<CString> object which will
			///											receive the pathnames of the project files.
			/// \return									The number of pathnames in rarrayProjectFilePathNames.
			///
			size_t CSolutionFileReader::GetProjectFilePathNames(CAtlArray<CString>& rarrayProjectFilePathNames) const
			{
				ATLASSERT(NULL != m_pImpl);
				if (NULL != m_pImpl)
				{
					return m_pImpl->GetProjectFilePathNames(rarrayProjectFilePathNames);
				}
				return 0;
			}


			/// \brief Retrieve the names of the configurations within the solution/workspace.
			///
			/// \param	rarrayConfigurations			A reference to a CAtlArray<CString> object which will
			///											receive the names of the configurations.
			/// \return									The number of configurations in rarrayProjectFilePathNames.
			///
			size_t CSolutionFileReader::GetConfigurations(CAtlArray<CString>& rarrayConfigurations) const
			{
				ATLASSERT(NULL != m_pImpl);
				if (NULL != m_pImpl)
				{
					return m_pImpl->GetConfigurations(rarrayConfigurations);
				}
				return 0;
			}


			/// \brief Determine whether the given solution configuration name is valid.
			///
			///	\param	sConfiguration		A configuration string identifying the configuration.
			/// \return						\em true if the configuration is valid; \em false otherwise.
			///
			bool CSolutionFileReader::IsValidConfiguration(const CString& sConfiguration) const
			{
				ATLASSERT(NULL != m_pImpl);
				if (NULL != m_pImpl)
				{
					return m_pImpl->IsValidConfiguration(sConfiguration);
				}
				return false;
			}


			/// \brief Retrieve the configuration string for the configuration of a project corresponding to the given solution/workspace configuration.
			///
			/// \param	sPathName			The pathname of the project.
			/// \param	sSolutionConfig		The name of the solution configuration.
			/// \return						The configuration string corresponding to sSolutionConfig, or an empty
			///								string if one cannot be found.
			///
			CString CSolutionFileReader::GetProjectConfigurationFromPathName(const CString& sPathName, const CString& sSolutionConfig) const
			{
				ATLASSERT(NULL != m_pImpl);
				if (NULL != m_pImpl)
				{
					return m_pImpl->GetProjectConfigurationFromPathName(sPathName, sSolutionConfig);
				}
				return _T("");
			}


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