org.eclipse.photran.ui.vpg/src/org/eclipse/photran/internal/ui/actions/DisplaySymbolTable.java

/*******************************************************************************
 * Copyright (c) 2007 University of Illinois at Urbana-Champaign and others.
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     UIUC - Initial API and implementation
 *******************************************************************************/
package org.eclipse.photran.internal.ui.actions;

import java.io.File;
import java.io.PrintStream;
import java.lang.reflect.InvocationTargetException;

import org.eclipse.core.runtime.IProgressMonitor;
import org.eclipse.jface.dialogs.MessageDialog;
import org.eclipse.photran.internal.core.analysis.binding.Definition;
import org.eclipse.photran.internal.core.analysis.binding.ImplicitSpec;
import org.eclipse.photran.internal.core.analysis.binding.ScopingNode;
import org.eclipse.photran.internal.core.parser.ASTExecutableProgramNode;
import org.eclipse.photran.internal.core.parser.GenericASTVisitor;
import org.eclipse.photran.internal.core.parser.IASTNode;
import org.eclipse.photran.internal.core.vpg.PhotranTokenRef;
import org.eclipse.rephraserengine.ui.UIUtil;

/**
 * Implements the Display Symbol Table action in the Refactor/(Debugging) menu
 *
 * @author Jeff Overbey
 */
public class DisplaySymbolTable extends FortranEditorASTActionDelegate
{
    public void run(IProgressMonitor progressMonitor) throws InvocationTargetException, InterruptedException
    {
        try
        {
        	progressMonitor.beginTask(Messages.DisplaySymbolTable_WaitingForBackgroundWorkToComplete, IProgressMonitor.UNKNOWN);

            File temp = UIUtil.createTempFile();
            final PrintStream ps = UIUtil.createPrintStream(temp);

            ps.println("SYMBOL TABLE - Derived from Virtual Program Graph"); //$NON-NLS-1$

        	getAST().accept(new GenericASTVisitor()
        	{
        		private int indentation = 0;

				@Override public void visitASTNode(IASTNode node)
				{
					if (!(node instanceof ScopingNode)) { traverseChildren(node); return; }
					if (node instanceof ASTExecutableProgramNode && node.getParent() != null) { traverseChildren(node); return; }

					ScopingNode scope = (ScopingNode)node;

					ps.println();
					describeScope(scope);

					indentation += 4;

					try
					{
						for (Definition d : scope.getAllDefinitions())
							println(describeDeclaration(d));
					}
					catch (Exception e)
					{
						println("EXCEPTION: " + e.getClass().getName() + ": " + e.getMessage()); //$NON-NLS-1$ //$NON-NLS-2$
						e.printStackTrace(ps);
					}

					traverseChildren(node);

					indentation -= 4;
				}

				private void describeScope(ScopingNode scope)
				{
					PhotranTokenRef representativeToken = scope.getRepresentativeToken();

					if (representativeToken.getOffset() < 0)
						print("(Global Scope)"); //$NON-NLS-1$
					else
						print("Scope: " + representativeToken.getText()); //$NON-NLS-1$

					if (scope.isInternal()) ps.print(" (Internal Subprogram)"); //$NON-NLS-1$

					if (scope.isDefaultVisibilityPrivate()) ps.print(" - Default Visibility is PRIVATE"); //$NON-NLS-1$

					ImplicitSpec implicitSpec = scope.getImplicitSpec();
					if (implicitSpec == null)
						ps.print(" - Implicit None"); //$NON-NLS-1$
					else
						ps.print(" - " + implicitSpec.toString()); //$NON-NLS-1$

					ps.println();
				}

				private void print(String text)
				{
					for (int i = 0; i < indentation; i++)
						ps.print(' ');
					ps.print(text);
				}

				private void println(String text)
				{
					print(text);
					ps.println();
				}
        	});

            ps.close();
            UIUtil.openHtmlViewerOn("Symbol Table", temp); //$NON-NLS-1$
        }
        catch (Exception e)
        {
        	String message = e.getMessage();
        	if (message == null) message = e.getClass().getName();
        	MessageDialog.openError(getFortranEditor().getShell(), "Error", message); //$NON-NLS-1$
        }
        finally
        {
        	progressMonitor.done();
        }
    }

//  ps.println("Symbol Table for " + editor.getIFile().getName());
//  IFortranAST ast = FortranWorkspace.getInstance().acquireTU(file,
//                                           new IncludeLoaderCallback(file.getProject())
//                                           {
//                                              public String onUnableToLoad(String message, String filename)
//                                              {
//                                                  ps.println("ERROR: " + message);
//                                                  return null;
//                                              }
//                                           },
//                                           new ModuleLoaderCallback()
//                                           {
//                                              public String onUnableToLoad(String message, Token moduleName)
//                                              {
//                                                  ps.println("ERROR: " + message);
//                                                  return null;
//                                              }
//                                           },
//                                           editor.isFixedForm(),
//                                           progressMonitor);
//  ps.println();
//  for (Token t : new IterableWrapper<Token>(ast))
//  {
//      Scope scope = (Scope)t.getScope();
//      if (scope != null)
//      {
//          scope.printGlobalSymbolTableOn(ps);
//          break;
//      }
//  }
}