/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*
*/
package org.apache.directory.studio.aciitemeditor.sourceeditor;
import java.util.ArrayList;
import java.util.List;
import org.eclipse.jface.text.rules.IRule;
import org.eclipse.jface.text.rules.IToken;
import org.eclipse.jface.text.rules.IWhitespaceDetector;
import org.eclipse.jface.text.rules.IWordDetector;
import org.eclipse.jface.text.rules.RuleBasedScanner;
import org.eclipse.jface.text.rules.SingleLineRule;
import org.eclipse.jface.text.rules.Token;
import org.eclipse.jface.text.rules.WhitespaceRule;
import org.eclipse.jface.text.rules.WordRule;
/**
* Scanner used to analyse ACI code. Allows syntax coloring.
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
public class ACICodeScanner extends RuleBasedScanner
{
/** 'identificationTag' keyword */
public static final String IDENTIFICATION_TAG_PARTITION = "identificationTag"; //$NON-NLS-1$
/** 'precedence' keyword */
public static final String PRECEDENCE_PARTITION = "precedence"; //$NON-NLS-1$
/** 'authenticationLevel' keyword */
public static final String AUTHENTICATION_LEVEL_PARTITION = "authenticationLevel"; //$NON-NLS-1$
/** Keywords for the itemOrUserFirst Section */
public static final String[] ITEM_OR_USER_FIRST_SECTION_PARTITION = new String[]
{ "itemOrUserFirst", "itemFirst", "userFirst" }; //$NON-NLS-1$ //$NON-NLS-2$ //$NON-NLS-3$
/** Keywords for 'userFirst' section */
public static final String[] USER_SECTION = new String[]
{ "userClasses", "userPermissions" }; //$NON-NLS-1$ //$NON-NLS-2$
/** Keywords for AciItems values */
public static final String[] ACI_KEYWORDS = new String[]
{ "protectedItems", //$NON-NLS-1$
"itemPermissions", //$NON-NLS-1$
"entry", //$NON-NLS-1$
"allUserAttributeTypes", //$NON-NLS-1$
"attributeType", //$NON-NLS-1$
"allAttributeValues", //$NON-NLS-1$
"allUserAttributeTypesAndValues", //$NON-NLS-1$
"attributeValue", //$NON-NLS-1$
"selfValue", //$NON-NLS-1$
"rangeOfValues", //$NON-NLS-1$
"maxValueCount", //$NON-NLS-1$
"maxImmSub", //$NON-NLS-1$
"restrictedBy", //$NON-NLS-1$
"classes", //$NON-NLS-1$
"grantsAndDenials", //$NON-NLS-1$
"allUsers", //$NON-NLS-1$
"thisEntry", //$NON-NLS-1$
"name", //$NON-NLS-1$
"userGroup", //$NON-NLS-1$
"subtree", //$NON-NLS-1$
"type", //$NON-NLS-1$
"valuesIn", //$NON-NLS-1$
"none", //$NON-NLS-1$
"simple", //$NON-NLS-1$
"strong" }; //$NON-NLS-1$
/** Keywords for grant values */
public static final String[] ACI_GRANT_VALUES = new String[]
{ "grantAdd", //$NON-NLS-1$
"grantDiscloseOnError", //$NON-NLS-1$
"grantRead", //$NON-NLS-1$
"grantRemove", //$NON-NLS-1$
"grantBrowse", //$NON-NLS-1$
"grantExport", //$NON-NLS-1$
"grantImport", //$NON-NLS-1$
"grantModify", //$NON-NLS-1$
"grantRename", //$NON-NLS-1$
"grantReturnDN", //$NON-NLS-1$
"grantCompare", //$NON-NLS-1$
"grantFilterMatch", //$NON-NLS-1$
"grantInvoke", }; //$NON-NLS-1$
/** Keywords for deny values */
public static final String[] ACI_DENY_VALUES = new String[]
{ "denyAdd", //$NON-NLS-1$
"denyDiscloseOnError", //$NON-NLS-1$
"denyRead", //$NON-NLS-1$
"denyRemove", //$NON-NLS-1$
"denyBrowse", //$NON-NLS-1$
"denyExport", //$NON-NLS-1$
"denyImport", //$NON-NLS-1$
"denyModify", //$NON-NLS-1$
"denyRename", //$NON-NLS-1$
"denyReturnDN", //$NON-NLS-1$
"denyCompare", //$NON-NLS-1$
"denyFilterMatch", //$NON-NLS-1$
"denyInvoke" }; //$NON-NLS-1$
/**
* Creates a new instance of AciCodeScanner.
*
* @param provider
* the provider
*/
public ACICodeScanner( ACITextAttributeProvider provider )
{
List<IRule> rules = new ArrayList<IRule>();
IToken keyword = new Token( provider.getAttribute( ACITextAttributeProvider.KEYWORD_ATTRIBUTE ) );
IToken undefined = new Token( provider.getAttribute( ACITextAttributeProvider.DEFAULT_ATTRIBUTE ) );
IToken string = new Token( provider.getAttribute( ACITextAttributeProvider.STRING_ATTRIBUTE ) );
IToken grantValue = new Token( provider.getAttribute( ACITextAttributeProvider.GRANT_VALUE ) );
IToken denyValue = new Token( provider.getAttribute( ACITextAttributeProvider.DENY_VALUE ) );
IToken identification = new Token( provider.getAttribute( ACITextAttributeProvider.IDENTIFICATION_ATTRIBUTE ) );
IToken precedence = new Token( provider.getAttribute( ACITextAttributeProvider.PRECEDENCE_ATTRIBUTE ) );
IToken authenticationLevel = new Token( provider
.getAttribute( ACITextAttributeProvider.AUTHENTICATIONLEVEL_ATTRIBUTE ) );
IToken itemOrUserFirst = new Token( provider.getAttribute( ACITextAttributeProvider.ITEMORUSERFIRST_ATTRIBUTE ) );
IToken user = new Token( provider.getAttribute( ACITextAttributeProvider.USER_ATTRIBUTE ) );
// Rules for Strings
rules.add( new SingleLineRule( "\"", "\"", string, '\0', true ) ); //$NON-NLS-1$ //$NON-NLS-2$
rules.add( new SingleLineRule( "'", "'", string, '\0', true ) ); //$NON-NLS-1$ //$NON-NLS-2$
// Generic rule for whitespaces
rules.add( new WhitespaceRule( new IWhitespaceDetector()
{
/**
* Indicates if the given character is a whitespace
* @param c the character to analyse
* @return <code>true</code> if the character is to be considered as a whitespace, <code>false</code> if not.
* @see org.eclipse.jface.text.rules.IWhitespaceDetector#isWhitespace(char)
*/
public boolean isWhitespace( char c )
{
return Character.isWhitespace( c );
}
} ) );
// If the word isn't in the List, returns undefined
WordRule worldRule = new WordRule( new AciWordDetector(), undefined );
// Adding Keywords
for ( String aciKeyword : ACI_KEYWORDS )
{
worldRule.addWord( aciKeyword, keyword );
}
// Adding GrantValues
for ( String aciGrantValue : ACI_GRANT_VALUES )
{
worldRule.addWord( aciGrantValue, grantValue );
}
// Adding DenyValues
for ( String aciDenyValue : ACI_DENY_VALUES )
{
worldRule.addWord( aciDenyValue, denyValue );
}
// Adding itemOrUserFirstSectionPartition
for ( String itemOrUserFirstSectionPartitionValue : ITEM_OR_USER_FIRST_SECTION_PARTITION )
{
worldRule.addWord( itemOrUserFirstSectionPartitionValue, itemOrUserFirst );
}
// Adding User
for ( String userSectionValue : USER_SECTION )
{
worldRule.addWord( userSectionValue, user );
}
worldRule.addWord( IDENTIFICATION_TAG_PARTITION, identification );
worldRule.addWord( PRECEDENCE_PARTITION, precedence );
worldRule.addWord( AUTHENTICATION_LEVEL_PARTITION, authenticationLevel );
rules.add( worldRule );
IRule[] param = new IRule[rules.size()];
rules.toArray( param );
setRules( param );
}
/**
* This class implements a word detector for ACI Items
*
* @author <a href="mailto:dev@directory.apache.org">Apache Directory Project</a>
*/
static class AciWordDetector implements IWordDetector
{
/**
* {@inheritDoc}
*/
public boolean isWordPart( char c )
{
return ( Character.isLetterOrDigit( c ) || c == '_' || c == '$' || c == '#' || c == '@' || c == '~'
|| c == '.' || c == '?' );
}
/**
* {@inheritDoc}
*/
public boolean isWordStart( char c )
{
return ( Character.isLetter( c ) || c == '.' || c == '_' || c == '?' || c == '$' );
}
}
}