defp and defmacrop structure

Includes generic support for visibility on call definitions and call
definition clauses.

src/org/elixir_lang/icons/ElixirIcons.java

@@ -25,17 +25,28 @@ public static RowIcon create(Icon... icons) {
  * Created by zyuyou on 15/7/6.
  */
 public interface ElixirIcons {
+
+  interface Time {
+    Icon COMPILE = AllIcons.Actions.Compile;
+    Icon RUN = AllIcons.General.Run;
+  }
+
+  interface Visibility {
+    Icon PRIVATE = PlatformIcons.PRIVATE_ICON;
+    Icon PUBLIC = PlatformIcons.PUBLIC_ICON;
+  }
+
+  Icon CALL_DEFINITION = PlatformIcons.FUNCTION_ICON;
+  Icon CALL_DEFINITION_CLAUSE = RowIconFactory.create(CALL_DEFINITION, PlatformIcons.PACKAGE_LOCAL_ICON);
   Icon DELEGATION = RowIconFactory.create(AllIcons.General.Run, PlatformIcons.PACKAGE_LOCAL_ICON);
   Icon EXCEPTION = PlatformIcons.EXCEPTION_CLASS_ICON;
   Icon FILE = IconLoader.getIcon("/icons/elixir-16.png");
-  Icon FUNCTION = RowIconFactory.create(AllIcons.General.Run, PlatformIcons.FUNCTION_ICON);
-  Icon FUNCTION_CLAUSE = RowIconFactory.create(FUNCTION, PlatformIcons.PACKAGE_LOCAL_ICON);
-  Icon FUNCTION_DELEGATION = FUNCTION_CLAUSE;
-  Icon MACRO = RowIconFactory.create(AllIcons.Actions.Compile, PlatformIcons.FUNCTION_ICON);
-  Icon MACRO_CLAUSE = RowIconFactory.create(MACRO, PlatformIcons.PACKAGE_LOCAL_ICON);
+  Icon IMPLEMENTATION = PlatformIcons.ANONYMOUS_CLASS_ICON;
   Icon MIX_MODULE_CONFLICT = AllIcons.Actions.Cancel;
   Icon MODULE = PlatformIcons.PACKAGE_ICON;
-  Icon IMPLEMENTATION = PlatformIcons.ANONYMOUS_CLASS_ICON;
+
+  // it is the unknown that is only a question mark
+  Icon UNKNOWN = AllIcons.RunConfigurations.Unknown;
 
   Icon ELIXIR_APPLICATION = IconLoader.getIcon("/icons/elixir-Application-16.png");
   Icon ELIXIR_SUPERVISOR = IconLoader.getIcon("/icons/elixir-Supervisor-16.png");

src/org/elixir_lang/navigation/item_presentation/CallDefinition.java

@@ -5,7 +5,9 @@
 import com.intellij.util.PlatformIcons;
 import org.elixir_lang.icons.ElixirIcons;
 import org.elixir_lang.structure_view.element.Timed;
+import org.elixir_lang.structure_view.element.Visible;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import javax.swing.*;
 
@@ -21,15 +23,27 @@ public class CallDefinition implements ItemPresentation {
     private final Parent parent;
     @NotNull
     private final Timed.Time time;
+    @Nullable
+    private final Visible.Visibility visibility;
 
+    /**
+     *
+     * @param parent
+     * @param time
+     * @param visibility {@code null} if clauses are a mix of private and public
+     * @param name
+     * @param arity
+     */
     public CallDefinition(@NotNull Parent parent,
                           @NotNull Timed.Time time,
+                          @Nullable Visible.Visibility visibility,
                           @NotNull String name,
                           int arity) {
         this.arity = arity;
         this.name = name;
         this.parent = parent;
         this.time = time;
+        this.visibility = visibility;
     }
 
     /**
@@ -63,22 +77,36 @@ public String getLocationString() {
     @NotNull
     @Override
     public Icon getIcon(boolean unused) {
-        RowIcon rowIcon = new RowIcon(2);
+        RowIcon rowIcon = new RowIcon(3);
         Icon timeIcon = null;
 
         switch (time) {
             case COMPILE:
-                timeIcon = ElixirIcons.MACRO;
+                timeIcon = ElixirIcons.Time.COMPILE;
                 break;
             case RUN:
-                timeIcon = ElixirIcons.FUNCTION;
+                timeIcon = ElixirIcons.Time.RUN;
                 break;
         }
 
         assert timeIcon != null;
 
+        Icon visibilityIcon = null;
+
+        switch (visibility) {
+            case PRIVATE:
+                visibilityIcon = ElixirIcons.Visibility.PRIVATE;
+                break;
+            case PUBLIC:
+                visibilityIcon = ElixirIcons.Visibility.PUBLIC;
+                break;
+            default:
+                visibilityIcon = ElixirIcons.UNKNOWN;
+        }
+
         rowIcon.setIcon(timeIcon, 0);
-        rowIcon.setIcon(PlatformIcons.PUBLIC_ICON, 1);
+        rowIcon.setIcon(visibilityIcon, 1);
+        rowIcon.setIcon(ElixirIcons.CALL_DEFINITION, 2);
 
         return rowIcon;
     }

src/org/elixir_lang/navigation/item_presentation/CallDefinitionClause.java

@@ -6,6 +6,7 @@
 import com.intellij.util.PlatformIcons;
 import org.elixir_lang.icons.ElixirIcons;
 import org.elixir_lang.psi.call.Call;
+import org.elixir_lang.structure_view.element.Visible;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
@@ -18,6 +19,7 @@ public class CallDefinitionClause implements ItemPresentation {
 
     private final Call call;
     private final CallDefinition callDefinition;
+    private final Visible.Visibility visibility;
 
     /*
      * Constructors
@@ -28,9 +30,12 @@ public class CallDefinitionClause implements ItemPresentation {
      * @param call a {@code Kernel.def/2} call nested in {@code parent}
      * @param callDefinition the parent {@link CallDefinition} of which {@code call} is a clause
      */
-    public CallDefinitionClause(@NotNull CallDefinition callDefinition, @NotNull Call call) {
+    public CallDefinitionClause(@NotNull CallDefinition callDefinition,
+                                @NotNull Visible.Visibility visibility,
+                                @NotNull Call call) {
         this.call = call;
         this.callDefinition = callDefinition;
+        this.visibility = visibility;
     }
 
     /*
@@ -73,22 +78,36 @@ public String getLocationString() {
     @Nullable
     @Override
     public Icon getIcon(boolean unused) {
-        RowIcon rowIcon = new RowIcon(2);
+        RowIcon rowIcon = new RowIcon(3);
         Icon timeIcon = null;
 
         switch (callDefinition.time()) {
             case COMPILE:
-                timeIcon = ElixirIcons.MACRO_CLAUSE;
+                timeIcon = ElixirIcons.Time.COMPILE;
                 break;
             case RUN:
-                timeIcon = ElixirIcons.FUNCTION_CLAUSE;
+                timeIcon = ElixirIcons.Time.RUN;
                 break;
         }
 
         assert timeIcon != null;
 
+        Icon visibilityIcon = null;
+
+        switch (visibility) {
+            case PRIVATE:
+                visibilityIcon = ElixirIcons.Visibility.PRIVATE;
+                break;
+            case PUBLIC:
+                visibilityIcon = ElixirIcons.Visibility.PUBLIC;
+                break;
+        }
+
+        assert visibilityIcon != null;
+
         rowIcon.setIcon(timeIcon, 0);
-        rowIcon.setIcon(PlatformIcons.PUBLIC_ICON, 1);
+        rowIcon.setIcon(visibilityIcon, 1);
+        rowIcon.setIcon(ElixirIcons.CALL_DEFINITION_CLAUSE, 2);
 
         return rowIcon;
     }

src/org/elixir_lang/navigation/item_presentation/FunctionDelegation.java

@@ -2,6 +2,7 @@
 
 import com.intellij.navigation.ItemPresentation;
 import com.intellij.openapi.util.text.StringUtil;
+import com.intellij.ui.RowIcon;
 import org.elixir_lang.icons.ElixirIcons;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
@@ -112,7 +113,14 @@ public String getLocationString() {
     @Nullable
     @Override
     public Icon getIcon(boolean unused) {
-        return ElixirIcons.FUNCTION_DELEGATION;
+        RowIcon rowIcon = new RowIcon(3);
+
+        // same as {@code def}
+        rowIcon.setIcon(ElixirIcons.Time.RUN, 0);
+        rowIcon.setIcon(ElixirIcons.Visibility.PUBLIC, 1);
+        rowIcon.setIcon(ElixirIcons.CALL_DEFINITION_CLAUSE, 2);
+
+        return rowIcon;
     }
 
     public String name() {

src/org/elixir_lang/structure_view/element/CallDefinition.java

@@ -7,14 +7,15 @@
 import org.elixir_lang.navigation.item_presentation.Parent;
 import org.elixir_lang.psi.call.Call;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 
 import java.util.ArrayList;
 import java.util.List;
 
 /**
  * A definition for a call: either a function or a macro
  */
-public class CallDefinition implements StructureViewTreeElement, Timed {
+public class CallDefinition implements StructureViewTreeElement, Timed, Visible {
     /*
      * Enums
      */
@@ -129,6 +130,7 @@ public ItemPresentation getPresentation() {
         return new org.elixir_lang.navigation.item_presentation.CallDefinition(
                 (Parent) module.getPresentation(),
                 time,
+                visibility(),
                 name,
                 arity
         );
@@ -164,4 +166,42 @@ public Time time() {
         return time;
     }
 
+    /**
+     * The visibility of the element.
+     *
+     * @return {@link Visibility.PUBLIC} for public call definitions ({@code def} and {@code defmacro});
+     * {@link Visibility.PRIVATE} for private call definitions ({@code defp} and {@code defmacrop}); {@code null} for
+     * a mix of visibilities, such as when a call definition has a mix of call definition clause visibilities, which
+     * is invalid code, but can occur temporarily while code is being edited.
+     */
+    @Nullable
+    @Override
+    public Visibility visibility() {
+
+        int privateCount = 0;
+        int publicCount = 0;
+
+        for (CallDefinitionClause callDefinitionClause : clauses) {
+            switch (callDefinitionClause.visibility()) {
+                case PRIVATE:
+                    privateCount++;
+                    break;
+                case PUBLIC:
+                    publicCount++;
+                    break;
+            }
+        }
+
+        Visibility callDefinitionVisibility;
+
+        if (privateCount > 0 && publicCount == 0) {
+            callDefinitionVisibility = Visibility.PRIVATE;
+        } else if (privateCount == 0 && publicCount > 0) {
+            callDefinitionVisibility = Visibility.PUBLIC;
+        } else {
+            callDefinitionVisibility = null;
+        }
+
+        return callDefinitionVisibility;
+    }
 }