DocCDataType.m

/*
	Copyright (C) 2010 Quentin Mathe

	Author:  Quentin Mathe <quentin.mathe@gmail.com>
	Date:  November 2010
	License:  Modified BSD (see COPYING)
 */

#import <objc/runtime.h>
#import "DocCDataType.h"
#import "DocDescriptionParser.h"
#import "DocIndex.h"
#import "DocHTMLElement.h"
#import "DocParameter.h"

@implementation DocCDataType

@synthesize type;

- (BOOL) isConstant
{
	return ([type hasPrefix: @"enum"] || [type hasPrefix: @"union"] 
		|| [type hasPrefix: @"const"] || [type hasSuffix: @"const"]);
}

- (void) turnIntoDocConstantIfNeeded
{
	if ([self isConstant])
	{
		object_setClass(self, [DocConstant class]);
	}
}

- (void) parser: (GSDocParser *)parser 
   startElement: (NSString *)elementName
  withAttributes: (NSDictionary *)attributeDict
{
	if ([elementName isEqualToString: [self GSDocElementName]]) /* Opening tag */
	{
		BEGINLOG();
		[self setType: [attributeDict objectForKey: @"type"]];
		[self setName: [attributeDict objectForKey: @"name"]];
	}
}

#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Warc-performSelector-leaks"

- (void) parser: (GSDocParser *)parser
     endElement: (NSString *)elementName
    withContent: (NSString *)trimmed
{
	if ([elementName isEqualToString: @"desc"]) 
	{
		[self appendToRawDescription: trimmed];
		CONTENTLOG();
	}
	else if ([elementName isEqualToString: [self GSDocElementName]]) /* Closing tag */
	{
		DocDescriptionParser* descParser = [DocDescriptionParser new];
		
		[descParser parse: [self rawDescription]];
		
		//NSLog(@"C Data Type raw description <%@>", [self rawDescription]);
		
		[self addInformationFrom: descParser];

		/* Switch the class to get the right -weaveSelector */
		[self turnIntoDocConstantIfNeeded];

		[(id)[parser weaver] performSelector: [self weaveSelector] withObject: self];

		ENDLOG2(name, [self task]);
	}
}

#pragma clang diagnostic pop

- (NSString *) GSDocElementName
{
	return @"type";
}

- (SEL) weaveSelector
{
	return @selector(weaveOtherDataType:);
}

- (NSString *) formattedType
{
	return [self type];

	// TODO: Fix or remove... This code wrongly truncates the types.
	// TODO: Insert links in the returned type
	DocParameter *formatter = [DocParameter parameterWithName: nil type: [self type]];
	NSString *formattedType = @"";

	if ([formatter typePrefix] != nil)
	{
		formattedType = [formattedType stringByAppendingString: [formatter typePrefix]];	
	}
	if ([formatter typeSuffix] != nil)
	{
		if ([formattedType length] != 0)
		{
			formattedType = [formattedType stringByAppendingFormat: @"%@ %@", @"", [formatter typeSuffix]];
		}
		else
		{
			formattedType = [formattedType stringByAppendingString: [formatter typeSuffix]];
		}
	}

	return formattedType;
}

- (DocHTMLElement *) HTMLRepresentation
{
	// TODO: Use more correct span class names
	H hType = [SPAN class: @"returnType" with: [SPAN class: @"type" with: [self formattedType]]];
	H hSymbolName = [SPAN class: @"selector" with: @" " and: [self name]];
	H hDesc = [DIV class: @"methodDescription" with: [self HTMLDescriptionWithDocIndex: [DocIndex currentIndex]]];
	H hDataType = [DIV class: @"method" with: [DL class: @"collapsable" with: [DT with: hType and: hSymbolName]
	                                                                     and: [DD with: hDesc]]];

	return hDataType;
}

@end


@implementation DocVariable

- (NSString *) GSDocElementName
{
	return @"variable";
}

- (SEL) weaveSelector
{
	return @selector(weaveConstant:);
}

- (void)parseProgramComponent: (SCKGlobal *)aVariable
{
	/*
	[self setName: [aVariable name]];
	[self setType: [aVariable typeEncoding]];
	[self appendToRawDescription: [[aVariable documentation] string]];
	
	DocDescriptionParser *descriptionParser = [DocDescriptionParser new];
	
	[descriptionParser parse: [self rawDescription]];
	[self addInformationFrom: descriptionParser];*/
}

@end


@implementation DocConstant

- (NSString *) GSDocElementName
{
	return @"constant";
}

- (SEL) weaveSelector
{
	return @selector(weaveConstant:);
}

- (void)parseProgramComponent: (id)aConstant
{
	[self setName: [aConstant name]];
	// FIXME: Needs fixing SCK to parse documentation.
	// Just check the value now in order to prevent throwing an exception.
	if (nil != [[aConstant documentation] string])
	{
		[self appendToRawDescription: [[aConstant documentation] string]];
	}
	else
	{
		[self appendToRawDescription: @""];
	}
	
	DocDescriptionParser *descriptionParser = [DocDescriptionParser new];
	
	[descriptionParser parse: [self rawDescription]];
	[self addInformationFrom: descriptionParser];
}

@end