Rebase a subset of Footprint*() PLUGIN API onto FP_LIB_TABLE (d77f95af) · Commits · Elphel / kicad-source-mirror

include/fp_lib_table.h

+62 −36

Original line number	Original line	Diff line number	Diff line
	@@ -366,42 +366,76 @@ public:
	// the returning of a const wxString* tells if not found, but might be too		// the returning of a const wxString* tells if not found, but might be too
	// promiscuous?		// promiscuous?

	#if 0		#if 0 // PLUGIN API SUBSET, REBASED ON aNickname

	/**		/**
	* Function GetURI		* Function FootprintEnumerate
	* returns the full library path from a logical library name.		* returns a list of footprint names contained within the library given by
	* @param aLogicalLibraryName is the short name for the library of interest.		* @a aNickname.
	* @return const wxString* - or NULL if not found.		*
			* @param aNickname is a locator for the "library", it is a "name"
			* in FP_LIB_TABLE::ROW
			*
			* @return wxArrayString - is the array of available footprint names inside
			* a library
			*
			* @throw IO_ERROR if the library cannot be found, or footprint cannot be loaded.
	*/		*/
	const wxString* GetURI( const wxString& aLogicalLibraryName ) const		wxArrayString FootprintEnumerate( const wxString& aNickname ) const;
	{
	const ROW* row = FindRow( aLogicalLibraryName );
	return row ? &row->uri : 0;
	}

	/**		/**
	* Function GetType		* Function FootprintLoad
	* returns the type of a logical library.		* loads a footprint having @a aFootprintName from the library given by @a aNickname.
	* @param aLogicalLibraryName is the short name for the library of interest.		*
	* @return const wxString* - or NULL if not found.		* @param aNickname is a locator for the "library", it is a "name"
			* in FP_LIB_TABLE::ROW
			*
			* @param aFootprintName is the name of the footprint to load.
			*
			* @return MODULE* - if found caller owns it, else NULL if not found.
			*
			* @throw IO_ERROR if the library cannot be found or read. No exception
			* is thrown in the case where aFootprintName cannot be found.
	*/		*/
	const wxString* GetType( const wxString& aLogicalLibraryName ) const		MODULE* FootprintLoad( const wxString& aNickname, const wxString& aFootprintName ) const;
	{
	const ROW* row = FindRow( aLogicalLibraryName );		/**
	return row ? &row->type : 0;		* Function FootprintSave
	}		* will write @a aFootprint to an existing library given by @a aNickname.
			* If a footprint by the same name already exists, it is replaced.
			*
			* @param aNickname is a locator for the "library", it is a "name"
			* in FP_LIB_TABLE::ROW
			*
			* @param aFootprint is what to store in the library. The caller continues
			* to own the footprint after this call.
			*
			* @throw IO_ERROR if there is a problem saving.
			*/
			void FootprintSave( const wxString& aNickname, const MODULE* aFootprint );

	/**		/**
	* Function GetLibOptions		* Function FootprintDelete
	* returns the options string for \a aLogicalLibraryName.		* deletes the @a aFootprintName from the library given by @a aNickname.
	* @param aLogicalLibraryName is the short name for the library of interest.		*
	* @return const wxString* - or NULL if not found.		* @param aNickname is a locator for the "library", it is a "name"
			* in FP_LIB_TABLE::ROW
			*
			* @param aFootprintName is the name of a footprint to delete from the specified library.
			*
			* @throw IO_ERROR if there is a problem finding the footprint or the library, or deleting it.
	*/		*/
	const wxString* GetLibOptions( const wxString& aLogicalLibraryName ) const		void FootprintDelete( const wxString& aNickname, const wxString& aFootprintName );
	{
	const ROW* row = FindRow( aLogicalLibraryName );		/**
	return row ? &row->options : 0;		* Function IsFootprintLibWritable
	}		* returns true iff the library given by @a aNickname is writable. (Often
			* system libraries are read only because of where they are installed.)
			*
			* @throw IO_ERROR if no library at aLibraryPath exists.
			*/
			bool IsFootprintLibWritable( const wxString& aNickname );

	#endif		#endif
	//----</read accessors>---------------------------------------------------		//----</read accessors>---------------------------------------------------

	@@ -444,14 +478,6 @@ public:
	*/		*/
	bool IsEmpty() const;		bool IsEmpty() const;

	/**
	* Function Assign
	* assigns new contents to ROWs of this table by copying ALL rows from aOther,
	* and modifying the size of this table if necessary.
	* @param aDestNdx is the starting index into this table.
	void Assign( const FP_LIB_TABLE& aOther, int aDestNdx );
	*/

	/**		/**
	* Function MissingLegacyLibs		* Function MissingLegacyLibs
	* tests the list of \a aLibNames by URI to determine if any of them are missing from		* tests the list of \a aLibNames by URI to determine if any of them are missing from

Admin message