Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[lang] Add operation extensions for Maps.
see #250 Signed-off-by: Stéphane Galland <galland@arakhne.org>
- Loading branch information
1 parent
e7e2b61
commit 5d7e00c
Showing
8 changed files
with
253 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
163 changes: 163 additions & 0 deletions
163
plugins/io.sarl.lang.core/src/io/sarl/lang/scoping/batch/SARLMapExtensions.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| /* | ||
| * $Id$ | ||
| * | ||
| * SARL is an general-purpose agent programming language. | ||
| * More details on http://www.sarl.io | ||
| * | ||
| * Copyright (C) 2014 Sebastian RODRIGUEZ, Nicolas GAUD, Stéphane GALLAND. | ||
| * | ||
| * Licensed 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 io.sarl.lang.scoping.batch; | ||
|
|
||
| import java.util.LinkedHashMap; | ||
| import java.util.Map; | ||
| import java.util.TreeMap; | ||
| import java.util.concurrent.ConcurrentMap; | ||
|
|
||
| import org.eclipse.xtext.xbase.lib.Inline; | ||
| import org.eclipse.xtext.xbase.lib.Pair; | ||
|
|
||
| import com.google.common.annotations.GwtCompatible; | ||
| import com.google.common.collect.Maps; | ||
|
|
||
|
|
||
| /** This is an extension library for {@link Map maps} in the SARL language. | ||
| * <p> | ||
| * This extension is provided for the elements that are not (yet) provided | ||
| * by the Xbase API. | ||
| * | ||
| * FIXME: Remove if Xbase or Xtend are providing these functions. | ||
| * | ||
| * @author $Author: sgalland$ | ||
| * @version $FullVersion$ | ||
| * @mavengroupid $GroupId$ | ||
| * @mavenartifactid $ArtifactId$ | ||
| */ | ||
| @GwtCompatible | ||
| public class SARLMapExtensions { | ||
|
|
||
| private static <K, V> Map<K, V> cloneMap(Map<K, V> oldMap) { | ||
| if (oldMap instanceof TreeMap<?, ?>) { | ||
| return Maps.newTreeMap((TreeMap<K, V>) oldMap); | ||
| } | ||
| if (oldMap instanceof LinkedHashMap<?, ?>) { | ||
| return Maps.newLinkedHashMap(oldMap); | ||
| } | ||
| if (oldMap instanceof ConcurrentMap<?, ?>) { | ||
| Map<K, V> m = Maps.newConcurrentMap(); | ||
| m.putAll(oldMap); | ||
| return m; | ||
| } | ||
| return Maps.newHashMap(oldMap); | ||
| } | ||
|
|
||
| /** Add the given pair into the map. | ||
| * | ||
| * @param map - the map to update. | ||
| * @param entry - the entry (key, value) to add into the map. | ||
| * @return the value previously associated to the key, or <code>null</code> | ||
| * if the key was not present in the map before the addition. | ||
| */ | ||
| @Inline(value="$1.put($2.getKey(), $2.getValue())") | ||
| public static <K, V> V operator_add(Map<K, V> map, Pair<? extends K, ? extends V> entry) { | ||
| return map.put(entry.getKey(), entry.getValue()); | ||
| } | ||
|
|
||
| /** Add the given entries of the input map into the output map. | ||
| * | ||
| * @param outputMap - the map to update. | ||
| * @param inputMap - the entries to add. | ||
| * @return the outputMap | ||
| */ | ||
| public static <K, V> Map<K, V> operator_add(Map<K, V> outputMap, Map<? extends K, ? extends V> inputMap) { | ||
| outputMap.putAll(inputMap); | ||
| return outputMap; | ||
| } | ||
|
|
||
| /** Add the given pair to a given map for obtaining a new map. | ||
| * | ||
| * @param map - the map to consider. | ||
| * @param entry - the entry (key, value) to add into the map. | ||
| * @return a map with the content of the map and with the given entry. | ||
| */ | ||
| public static <K, V> Map<K, V> operator_plus(Map<K, V> map, Pair<? extends K, ? extends V> entry) { | ||
| Map<K, V> newMap = cloneMap(map); | ||
| newMap.put(entry.getKey(), entry.getValue()); | ||
| return newMap; | ||
| } | ||
|
|
||
| /** Add the given pair to a given map for obtaining a new map. | ||
| * | ||
| * @param entry - the entry (key, value) to add into the map. | ||
| * @param map - the map to consider. | ||
| * @return a map with the content of the map and with the given entry. | ||
| */ | ||
| public static <K, V> Map<K, V> operator_plus(Pair<? extends K, ? extends V> entry, Map<K, V> map) { | ||
| Map<K, V> newMap = cloneMap(map); | ||
| newMap.put(entry.getKey(), entry.getValue()); | ||
| return newMap; | ||
| } | ||
|
|
||
| /** Merge the given maps. | ||
| * If a key exists in the two maps, the value in the second map is retained. | ||
| * | ||
| * @param map - the first map. | ||
| * @param map2 - the second map. | ||
| * @return a map with the merged contents from the two maps. | ||
| */ | ||
| public static <K, V> Map<K, V> operator_plus(Map<K, V> map, Map<? extends K, ? extends V> map2) { | ||
| Map<K, V> newMap = cloneMap(map); | ||
| newMap.putAll(map2); | ||
| return newMap; | ||
| } | ||
|
|
||
| /** Remove a key from the given map. | ||
| * | ||
| * @param map - the map to update. | ||
| * @param key - the key to remove. | ||
| * @return the removed value, or <code>null</code> if the key was not | ||
| * present in the map. | ||
| */ | ||
| @Inline("$1.remove($2)") | ||
| public static <K, V> V operator_remove(Map<K, V> map, K key) { | ||
| return map.remove(key); | ||
| } | ||
|
|
||
| /** Create a copy of the given map without the given key. | ||
| * | ||
| * @param map - the map to update. | ||
| * @param key - the key to remove. | ||
| * @return the removed value, or <code>null</code> if the key was not | ||
| * present in the map. | ||
| */ | ||
| public static <K, V> Map<K, V> operator_minus(Map<K, V> map, K key) { | ||
| Map<K, V> newMap = cloneMap(map); | ||
| newMap.remove(key); | ||
| return newMap; | ||
| } | ||
|
|
||
| /** Replies the value associated to the key in the given map. | ||
| * | ||
| * @param map - the map. | ||
| * @param key - the key. | ||
| * @return the value, or <code>null</code> if the key is not | ||
| * present in the map. | ||
| */ | ||
| @Inline("$1.get($2)") | ||
| public static <K, V> V operator_mappedTo(Map<K, V> map, K key) { | ||
| return map.get(key); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
56 changes: 56 additions & 0 deletions
56
plugins/io.sarl.lang/src/io/sarl/lang/scoping/batch/SARLImplicitlyImportedFeatures.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| /* | ||
| * $Id$ | ||
| * | ||
| * SARL is an general-purpose agent programming language. | ||
| * More details on http://www.sarl.io | ||
| * | ||
| * Copyright (C) 2014 Sebastian RODRIGUEZ, Nicolas GAUD, Stéphane GALLAND. | ||
| * | ||
| * Licensed 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 io.sarl.lang.scoping.batch; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.eclipse.xtext.xbase.scoping.batch.ImplicitlyImportedFeatures; | ||
|
|
||
| import com.google.inject.Singleton; | ||
|
|
||
|
|
||
| /** Provider of the implicitly imported features in the SARL language. | ||
| * | ||
| * @author $Author: sgalland$ | ||
| * @version $FullVersion$ | ||
| * @mavengroupid $GroupId$ | ||
| * @mavenartifactid $ArtifactId$ | ||
| */ | ||
| @Singleton | ||
| public class SARLImplicitlyImportedFeatures extends ImplicitlyImportedFeatures { | ||
|
|
||
| /** | ||
| */ | ||
| public SARLImplicitlyImportedFeatures() { | ||
| super(); | ||
| } | ||
|
|
||
| @Override | ||
| protected List<Class<?>> getExtensionClasses() { | ||
| List<Class<?>> xtextList = super.getExtensionClasses(); | ||
| // Insert at the beginning for ensuring the SARL extension is selected before any Xtext extension. | ||
| xtextList.add(0, SARLMapExtensions.class); | ||
| return xtextList; | ||
| } | ||
|
|
||
| } | ||
|
|