Click here to Skip to main content
Click here to Skip to main content
Add your own
alternative version

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

, , 29 Jan 2009 CPOL
Utility to run PC-Lint on Visual C++ solutions and projects, generating XML and HTML reports of the results.
/************************************************************************
 *
 *  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

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

Share

About the Authors

Anna-Jayne Metcalfe
Founder Riverblade Limited
United Kingdom United Kingdom
I haven't always written software for a living. When I graduated from Surrey University in 1989, it was with an Electronic Engineering degree, but unfortunately that never really gave me the opportunity to do anything particularly interesting (with the possible exception of designing Darth Vader's Codpiece * for the UK Army in 1990).
    * Also known as the Standard Army Bootswitch. But that's another story...
Since the opportunity arose to lead a software team developing C++ software for Avionic Test Systems in 1996, I've not looked back. More recently I've been involved in the development of subsea acoustic navigation systems, digital TV broadcast systems, port security/tracking systems, and most recently software development tools with my own company, Riverblade Ltd.
 
One of my personal specialities is IDE plug-in development. ResOrg was my first attempt at a plug-in, but my day to day work is with Visual Lint, an interactive code analysis tool environment with works within the Visual Studio and Eclipse IDEs or on build servers.
 
I love lots of things, but particularly music, photography and anything connected with history or engineering. I despise ignorant, intolerant and obstructive people - and it shows...I can be a bolshy cow if you wind me up the wrong way...Laugh | :laugh:
 
I'm currently based 15 minutes walk from the beach in Bournemouth on the south coast of England. Since I moved here I've grown to love the place - even if it is full of grockles in Summer!
Follow on   Twitter

-+- Beth Mackenzie -+-
Software Developer Riverblade Ltd
United Kingdom United Kingdom
I'm a software developer and/or tester with Riverblade Ltd (www.riverblade.co.uk) developing our core product range including our Visual Lint integration product and Lint Project Professional.
 
I incorporate a number of technologies into a daily basis including Windows API, C++ (VS2008), Managed C++, CLI, Databases, Java, JNI, Eclipse Framework, CDT and of course Visual Studio Extensibility (VSIP VSX).
 
In my spare time I enjoy cooking (prepping ingredients from scratch!), running, cycling, swimming, reading, interested in experimental electronic music (such as ClockDVA), movies, volunteering my IT skills where I can.

| Advertise | Privacy | Terms of Use | Mobile
Web01 | 2.8.150129.1 | Last Updated 29 Jan 2009
Article Copyright 2004 by Anna-Jayne Metcalfe, -+- Beth Mackenzie -+-
Everything else Copyright © CodeProject, 1999-2015
Layout: fixed | fluid