baseten / Sources / BXHOM.h

//
// BXHOM.h
// BaseTen
//
// Copyright (C) 2008-2010 Marko Karppinen & Co. LLC.
//
// Before using this software, please review the available licensing options
// by visiting http://www.karppinen.fi/baseten/licensing/ or by contacting
// us at sales@karppinen.fi. Without an additional license, this software
// may be distributed only in compliance with the GNU General Public License.
//
//
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License, version 2.0,
// as published by the Free Software Foundation.
//
// This program 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
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
//
// $Id$
//

#import <Foundation/Foundation.h>


@protocol BXHOM <NSObject>
- (id) BX_Any;
- (id) BX_Do;
- (id) BX_Collect;
- (id) BX_CollectReturning: (Class) aClass;

/**
 * \internal
 * \brief Make a dictionary of collected objects.
 *
 * Make existing objects values and collected objects keys.
 * \return An invocation recorder that creates an NSDictionary.
 */
- (id) BX_CollectD;

/**
 * \internal
 * \brief Make a dictionary of collected objects.
 *
 * Make existing objects keys and collected objects values.
 * \return An invocation recorder that creates an NSDictionary.
 */
- (id) BX_CollectDK;

/**
 * \internal
 * \brief Visit each item.
 *
 * The first parameter after self and _cmd will be replaced with the visited object.
 * \param visitor The object that will be called.
 * \return An invocation recorder.
 */
- (id) BX_Visit: (id) visitor;
@end



@protocol BXSetHOM <BXHOM>
- (id) BX_SelectFunction: (int (*)(id)) fptr;
- (id) BX_SelectFunction: (int (*)(id, void*)) fptr argument: (void *) arg;
@end



@protocol BXArrayHOM <BXHOM>
- (NSArray *) BX_Reverse;
- (id) BX_SelectFunction: (int (*)(id)) fptr;
- (id) BX_SelectFunction: (int (*)(id, void*)) fptr argument: (void *) arg;
@end



@protocol BXDictionaryHOM <BXHOM>
/**
 * \internal
 * \brief Make a dictionary of objects collected from keys.
 *
 * Make existing objects values and collected objects keys.
 * \return An invocation recorder that creates an NSDictionary.
 */
- (id) BX_KeyCollectD;

- (id) BX_ValueSelectFunction: (int (*)(id)) fptr;
- (id) BX_ValueSelectFunction: (int (*)(id, void*)) fptr argument: (void *) arg;
@end



@interface NSSet (BXHOM) <BXSetHOM>
@end



@interface NSArray (BXHOM) <BXArrayHOM>
@end



@interface NSDictionary (BXHOM) <BXDictionaryHOM>
@end



#if ! (defined (TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
@interface NSHashTable (BXHOM) <BXSetHOM>
@end
#endif



#if ! (defined (TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
@interface NSMapTable (BXHOM) <BXDictionaryHOM>
@end
#endif
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.