private void checkFunction(final RefactoringStatus result) {
if ((fFunction.getElementType() & IRElement.MASK_C2) != IRElement.R_COMMON_FUNCTION
&& (fFunction.getElementType() & IRElement.MASK_C2) != IRElement.R_COMMON_FUNCTION) {
result.merge(
RefactoringStatus.createFatalErrorStatus(
Messages.FunctionToS4Method_error_SelectionAlreadyS4_message));
return;
}
final RAstNode node = (RAstNode) fFunction.getAdapter(IAstNode.class);
if (RAst.hasErrors(node)) {
result.merge(
RefactoringStatus.createWarningStatus(
Messages.FunctionToS4Method_warning_SelectionSyntaxError_message));
}
// if (fSelectionRegion != null
// && (fSelectionRegion.getOffset() != fOperationRegion.getOffset() ||
// fSelectionRegion.getLength() != fOperationRegion.getLength())) {
// result.merge(RefactoringStatus.createWarningStatus("The selected code does not equal
// exactly the found expression(s)."));
// }
RElementName elementName = fFunction.getElementName();
while (elementName.getNextSegment() != null) {
elementName = elementName.getNamespace();
}
fFunctionName = elementName.getDisplayName();
final ArgsDefinition argsDef = fFunction.getArgsDefinition();
final int count = (argsDef != null) ? argsDef.size() : 0;
fVariablesList = new ArrayList(count);
boolean dots = false;
for (int i = 0; i < count; i++) {
final Arg arg = argsDef.get(i);
final Variable variable = new Variable(arg);
if (variable.getName().equals(RTerminal.S_ELLIPSIS)) {
dots = true;
variable.init(true);
} else {
variable.init(!dots);
}
fVariablesList.add(variable);
}
}
/**
* Generates content for the Roxygen comment for the given function definition
*
* @param rMethod function element
* @param lineDelimiter the line delimiter to be used
* @return
* @throws CoreException thrown when the evaluation of the code template fails
*/
public static EvaluatedTemplate getCommonFunctionRoxygenComment(
final IRMethod rMethod, final String lineDelimiter) throws CoreException {
final Template template =
RUIPlugin.getDefault()
.getRCodeGenerationTemplateStore()
.findTemplate(RCodeTemplatesContextType.ROXYGEN_COMMONFUNCTION_TEMPLATE);
if (template == null) {
return null;
}
final ISourceUnit su = rMethod.getSourceUnit();
final RCodeTemplatesContext context =
new RCodeTemplatesContext(
RCodeTemplatesContextType.ROXYGEN_COMMONFUNCTION_CONTEXTTYPE, su, lineDelimiter);
context.setRElement(rMethod);
try {
final TemplateBuffer buffer = context.evaluate(template);
if (buffer == null) {
return null;
}
final EvaluatedTemplate data = new EvaluatedTemplate(buffer, lineDelimiter);
final AbstractDocument content = data.startPostEdit();
final StringBuilder tagBuffer = new StringBuilder(64);
final TemplateVariable paramVariable =
TemplatesUtil.findVariable(buffer, RCodeTemplatesContextType.ROXYGEN_PARAM_TAGS_VARIABLE);
final Position[] paramPositions =
new Position[(paramVariable != null) ? paramVariable.getOffsets().length : 0];
for (int i = 0; i < paramPositions.length; i++) {
paramPositions[i] = new Position(paramVariable.getOffsets()[i], paramVariable.getLength());
content.addPosition(paramPositions[i]);
}
if (paramPositions.length > 0) {
String[] tags = null;
final ArgsDefinition args = rMethod.getArgsDefinition();
if (args != null) {
final int count = args.size();
tags = new String[count];
for (int i = 0; i < count; i++) {
tagBuffer.append("@param "); // $NON-NLS-1$
tagBuffer.append(args.get(i).name);
tagBuffer.append(" "); // $NON-NLS-1$
tags[i] = tagBuffer.toString();
tagBuffer.setLength(0);
}
}
for (final Position pos : paramPositions) {
insertRoxygen(content, pos, tags);
}
}
data.finishPostEdit();
return data;
} catch (final Exception e) {
throw new CoreException(
new Status(
IStatus.ERROR,
RUI.PLUGIN_ID,
NLS.bind(
TemplateMessages.TemplateEvaluation_error_description, template.getDescription()),
e));
}
}
/**
* Generates content for the Roxygen comment for the given method definition
*
* @param rMethod function element
* @param lineDelimiter the line delimiter to be used
* @return
* @throws CoreException thrown when the evaluation of the code template fails
*/
public static EvaluatedTemplate getMethodRoxygenComment(
final IRMethod rMethod, final String lineDelimiter) throws CoreException {
final Template template =
RUIPlugin.getDefault()
.getRCodeGenerationTemplateStore()
.findTemplate(RCodeTemplatesContextType.ROXYGEN_S4METHOD_TEMPLATE);
if (template == null) {
return null;
}
final ISourceUnit su = rMethod.getSourceUnit();
final RCodeTemplatesContext context =
new RCodeTemplatesContext(
RCodeTemplatesContextType.ROXYGEN_METHOD_CONTEXTTYPE, su, lineDelimiter);
context.setRElement(rMethod);
try {
final TemplateBuffer buffer = context.evaluate(template);
if (buffer == null) {
return null;
}
final EvaluatedTemplate data = new EvaluatedTemplate(buffer, lineDelimiter);
final AbstractDocument content = data.startPostEdit();
final StringBuilder sb = new StringBuilder(64);
final Position[] sigPositions;
String sigText = null;
{
final TemplateVariable variable =
TemplatesUtil.findVariable(buffer, RCodeTemplatesContextType.ROXYGEN_SIG_LIST_VARIABLE);
sigPositions = new Position[(variable != null) ? variable.getOffsets().length : 0];
for (int i = 0; i < sigPositions.length; i++) {
sigPositions[i] = new Position(variable.getOffsets()[i], variable.getLength());
content.addPosition(sigPositions[i]);
}
if (sigPositions.length > 0) {
final ArgsDefinition args = rMethod.getArgsDefinition();
if (args != null) {
final int count = args.size();
for (int i = 0; i < count; i++) {
final Arg arg = args.get(i);
if (arg.className == null || arg.className.equals("ANY")) { // $NON-NLS-1$
break;
}
sb.append(arg.className);
sb.append(","); // $NON-NLS-1$
}
if (sb.length() > 0) {
sigText = sb.substring(0, sb.length() - 1);
sb.setLength(0);
}
}
}
}
final Position[] paramPositions;
String[] paramTags = null;
{
final TemplateVariable variable =
TemplatesUtil.findVariable(
buffer, RCodeTemplatesContextType.ROXYGEN_PARAM_TAGS_VARIABLE);
paramPositions = new Position[(variable != null) ? variable.getOffsets().length : 0];
for (int i = 0; i < paramPositions.length; i++) {
paramPositions[i] = new Position(variable.getOffsets()[i], variable.getLength());
content.addPosition(paramPositions[i]);
}
if (paramPositions.length > 0) {
String list = null;
final ArgsDefinition args = rMethod.getArgsDefinition();
if (args != null) {
final int count = args.size();
paramTags = new String[count];
for (int i = 0; i < count; i++) {
sb.append("@param "); // $NON-NLS-1$
sb.append(args.get(i).name);
sb.append(" "); // $NON-NLS-1$
paramTags[i] = sb.toString();
sb.setLength(0);
}
}
}
}
if (sigPositions != null) {
for (final Position pos : sigPositions) {
insertRoxygen(content, pos, sigText);
}
}
if (paramPositions != null) {
for (final Position pos : paramPositions) {
insertRoxygen(content, pos, paramTags);
}
}
data.finishPostEdit();
return data;
} catch (final Exception e) {
throw new CoreException(
new Status(
IStatus.ERROR,
RUI.PLUGIN_ID,
NLS.bind(
TemplateMessages.TemplateEvaluation_error_description, template.getDescription()),
e));
}
}
