path: root/logo/src/xlogo/kernel/Primitive.java

/* XLogo4Schools - A Logo Interpreter specialized for use in schools, based on XLogo by Loic Le Coq
 * Copyright (C) 2013 Marko Zivkovic
 * 
 * Contact Information: marko88zivkovic at gmail dot com
 * 
 * This program is free software; you can redistribute it and/or modify it 
 * under the terms of the GNU General Public License as published by the Free 
 * Software Foundation; either version 2 of the License, or (at your option) 
 * any later version.  This program is distributed in the hope that it will be 
 * useful, but WITHOUT ANY WARRANTY; without even the implied warranty of 
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General 
 * Public License for more details.  You should have received a copy of the 
 * GNU General Public License along with this program; if not, write to the Free 
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, 
 * MA 02110-1301, USA.
 * 
 * 
 * This Java source code belongs to XLogo4Schools, written by Marko Zivkovic
 * during his Bachelor thesis at the computer science department of ETH Zurich,
 * in the year 2013 and/or during future work.
 * 
 * It is a reengineered version of XLogo written by Loic Le Coq, published
 * under the GPL License at http://xlogo.tuxfamily.org/
 * 
 * Contents of this file were initially written by Loic Le Coq,
 * modifications, extensions, refactorings might have been applied by Marko Zivkovic 
 */

/**
 * Title : XLogo Description : XLogo is an interpreter for the Logo programming
 * language
 * 
 * @author Loïc Le Coq
 */
package xlogo.kernel;

import java.util.Vector;
import java.util.Collections;
import java.util.Locale;
import java.util.ResourceBundle;
import java.util.Stack;
import java.util.StringTokenizer;
import java.util.TreeMap;
import java.math.BigDecimal;

import xlogo.kernel.LoopProperties;
import xlogo.messages.async.history.HistoryMessenger;
import xlogo.storage.WSManager;
import xlogo.storage.workspace.Language;
import xlogo.utils.Utils;
import xlogo.Application;

import java.io.*;

import xlogo.Logo;

import java.util.Enumeration;

public class Primitive
{
	/**
	 * This character indicates the end of a procedure in instructionBuffer
	 */
	protected static final String			END_PROCEDURE		= "\n";
	/**
	 * This character indicates the end of a loop in instructionBuffer
	 */
	protected static final String			END_LOOP			= "\\";
	
	// float taille_crayon=(float)0;
	private Application						app;
	protected static final int				PRIMITIVE_NUMBER	= 310;
	protected static int[]					parametres			= new int[PRIMITIVE_NUMBER];
	protected static boolean[]				generalForm			= new boolean[PRIMITIVE_NUMBER];
	
	// Treemap for primitives (better efficiency in searching)
	public static TreeMap<String, String>	primitives			= new TreeMap<String, String>();
	
	public static Stack<LoopProperties>		stackLoop			= new Stack<LoopProperties>();
	
	public Primitive()
	{
	}
	
	public Primitive(Application app)
	{
		this.app = app;
		// build treemap for primitives
		buildPrimitiveTreemap(WSManager.getInstance().getWorkspaceConfigInstance().getLanguage());
	}
	
	/**
	 * This methods returns a list which contains all the primitive for the
	 * current language
	 * 
	 * @return The primitives list
	 */
	protected String getAllPrimitives()
	{
		Vector<String> list = new Vector<String>();
		Locale locale = WSManager.getInstance().getWorkspaceConfigInstance().getLanguage().getLocale();
		ResourceBundle prim = ResourceBundle.getBundle("primitives", locale);
		try
		{
			BufferedReader bfr = new BufferedReader(new InputStreamReader(
					Primitive.class.getResourceAsStream("genericPrimitive")));
			while (bfr.ready())
			{
				String line = bfr.readLine();
				// read the generic keyword for the primitive
				StringTokenizer cut = new StringTokenizer(line);
				// read the standard number of arguments for the primitive
				String cle = cut.nextToken();
				// Exclude internal primitive \n \x and siwhile
				if (!cle.equals("\\n") && !cle.equals("\\siwhile") && !cle.equals("\\x"))
				{
					// Exclude all arithmetic symbols + - / * & |
					if (cle.length() != 1)
					{
						if (!cle.equals(">=") && !cle.equals("<="))
						{
							cle = prim.getString(cle).trim();
							list.add(cle);
						}
					}
				}
			}
		}
		catch (IOException e)
		{
			System.out.println("Impossible de lire le fichier d'initialisation des primitives");
		}
		Collections.sort(list);
		StringBuffer sb = new StringBuffer("[ ");
		for (int i = 0; i < list.size(); i++)
		{
			sb.append("[ ");
			sb.append(list.get(i));
			sb.append("] ");
		}
		sb.append("] ");
		return (sb.toString());
	}
	
	// Exécution des primitives
	public static void buildPrimitiveTreemap(Language lang)
	{
		// this.exportPrimCSV();
		primitives = new TreeMap<String, String>();
		Locale locale = lang.getLocale();
		ResourceBundle prim = ResourceBundle.getBundle("primitives", locale);
		try
		{
			BufferedReader bfr = new BufferedReader(new InputStreamReader(
					Primitive.class.getResourceAsStream("genericPrimitive")));
			int i = 0;
			while (bfr.ready())
			{
				String line = bfr.readLine();
				// read the generic keyword for the primitive
				StringTokenizer cut = new StringTokenizer(line);
				// read the standard number of arguments for the primitive
				String cle = cut.nextToken();
				parametres[i] = Integer.parseInt(cut.nextToken());
				// Read if the primitive has a general form
				// eg (sum 2 3 4 5) --> 14
				// eg (list 3 4 5) ---> [3 4 5]
				if (cut.hasMoreTokens())
				{
					generalForm[i] = true;
				}
				else
					generalForm[i] = false;
				
				if (i == 39)
					primitives.put("\n", "39");
				// Internal Primitive siwhile
				else if (i == 95)
				{
					primitives.put("\\siwhile", "95");
				}
				// Internal Primitive \x
				else if (i == 212)
					primitives.put("\\x", "212");
				else
				{
					if (cle.length() != 1)
					{
						if (!cle.equals(">=") && !cle.equals("<="))
							cle = prim.getString(cle);
					}
					StringTokenizer st = new StringTokenizer(cle.toLowerCase());
					int compteur = 0;
					while (st.hasMoreTokens())
					{
						primitives.put(st.nextToken(), String.valueOf(i + Primitive.PRIMITIVE_NUMBER * compteur));
						compteur++;
					}
				}
				i++;
			}
			/*
			 * System.out.println(i+ " primitives");
			 * java.util.Iterator it=primitives.keySet().iterator();
			 * while(it.hasNext()){
			 * String next=it.next().toString();
			 * System.out.println(next+" "+primitives.get(next));
			 * }
			 */
		}
		catch (IOException e)
		{
			System.out.println("Impossible de lire le fichier d'initialisation des primitives");
		}
	}
	
	/**
	 * This method creates the loop "repeat"
	 * 
	 * @param i
	 *            The number of iteration
	 * @param st
	 *            The instruction to execute
	 * @throws LogoError
	 */
	protected void repete(int i, String st) throws LogoError
	{
		if (i > 0)
		{
			st = new String(Utils.decoupe(st));
			LoopProperties bp = new LoopRepeat(BigDecimal.ONE, new BigDecimal(i), BigDecimal.ONE, st);
			stackLoop.push(bp);
			app.getKernel().getInstructionBuffer().insert(st + "\\ ");
		}
		else if (i != 0) { throw new LogoError(Utils.primitiveName("controls.repete") + " "
				+ Logo.messages.getString("attend_positif")); }
	}
	
	/**
	 * This method is an internal primitive for the primitive "while"
	 * 
	 * @param b
	 *            Do we still execute the loop body?
	 * @param li
	 *            The loop body instructions
	 * @throws LogoError
	 */
	protected void whilesi(boolean b, String li) throws LogoError
	{
		if (b)
		{
			app.getKernel().getInstructionBuffer().insert(li + Primitive.stackLoop.peek().getInstr());
		}
		else
		{
			eraseLevelStop(app);
		}
	}
	
	// primitive if
	protected void si(boolean b, String li, String li2)
	{
		if (b)
		{
			app.getKernel().getInstructionBuffer().insert(li);
		}
		else if (null != li2)
		{
			app.getKernel().getInstructionBuffer().insert(li2);
		}
	}
	
	// primitive stop
	protected void stop() throws LogoError
	{
		Interprete.operande = false;
		String car = "";
		car = eraseLevelStop(app);
		
		// A procedure has been stopped
		if (car.equals("\n"))
		{
			String en_cours = Interprete.en_cours.pop();
			Interprete.locale = Interprete.stockvariable.pop();
			// Example: to bug
			// fd stop
			// end
			// --------
			// bug
			// stop doesn't output to fd
			if (!Interprete.nom.isEmpty() && !Interprete.nom.peek().equals("\n"))
			{
				// System.out.println(Interprete.nom);
				throw new LogoError(Utils.primitiveName("controls.stop") + " "
						+ Logo.messages.getString("ne_renvoie_pas") + " " + Interprete.nom.peek());
			}
			else if (!Interprete.nom.isEmpty())
			{
				// Removing the character "\n"
				Interprete.nom.pop();
				// Example: to bug | to bug2
				// fd bug2 | stop
				// end | end
				// ------------------------
				// bug
				// bug2 doesn't output to fd
				if (!Interprete.nom.isEmpty() && !Interprete.nom.peek().equals("\n"))
				{
					// System.out.println(Interprete.nom);
					throw new LogoError(en_cours + " " + Logo.messages.getString("ne_renvoie_pas") + " "
							+ Interprete.nom.peek());
				}
			}
		}
	}
	
	// primitive output
	protected void retourne(String val) throws LogoError
	{
		Interprete.calcul.push(val);
		Interprete.operande = true;
		if (Kernel.mode_trace)
		{
			StringBuffer buffer = new StringBuffer();
			for (int i = 0; i < Interprete.en_cours.size() - 1; i++)
				buffer.append("  ");
			buffer.append(Interprete.en_cours.peek());
			buffer.append(" " + Utils.primitiveName("ret") + " " + val);
			HistoryMessenger.getInstance().dispatchMessage(Utils.SortieTexte(buffer.toString()) + "\n");
		}
		Interprete.en_cours.pop();
		Interprete.locale = Interprete.stockvariable.pop();
		if ((!Interprete.nom.isEmpty()) && Interprete.nom.peek().equals("\n"))
		{
			eraseLevelReturn(app);
			Interprete.nom.pop();
		}
		else if (!Interprete.nom.isEmpty())
			throw new LogoError(Utils.primitiveName("ret") + " " + Logo.messages.getString("ne_renvoie_pas") + " "
					+ Interprete.nom.peek());
		else
			throw new LogoError(Logo.messages.getString("erreur_retourne"));
	}
	
	/**
	 * This method deletes all instruction since it encounters the end of a loop
	 * or the end of a procedure
	 * 
	 * @param app
	 *            The runnning frame Application
	 * @return The specific character \n or \ if found
	 * @throws LogoError
	 */
	private String eraseLevelStop(Application app) throws LogoError
	{
		boolean error = true;
		String caractere = "";
		int marqueur = 0;
		InstructionBuffer instruction = app.getKernel().getInstructionBuffer();
		for (int i = 0; i < instruction.getLength(); i++)
		{
			caractere = String.valueOf(instruction.charAt(i));
			if (caractere.equals(Primitive.END_LOOP) | caractere.equals(Primitive.END_PROCEDURE))
			{
				marqueur = i;
				if (caractere.equals(Primitive.END_LOOP) && i != instruction.getLength() - 1)
				{
					/*
					 * On test si le caractère "\" est bien un caractère de
					 * fin
					 * de boucle et non du style "\e" ou "\#"
					 */
					if (instruction.charAt(i + 1) == ' ')
					{
						error = false;
						break;
					}
				}
				else
				{
					error = false;
					break;
				}
			}
		}
		
		if (error) { throw new LogoError(Logo.messages.getString("erreur_stop")); }
		if (marqueur + 2 > instruction.getLength())
			instruction = new InstructionBuffer(" ");
		else
			instruction.delete(0, marqueur + 2);
		if (!caractere.equals("\n"))
		{
			Primitive.stackLoop.pop();
		}
		return (caractere);
	}
	
	/**
	 * This method deletes all instruction since it encounters the end of a
	 * procedure
	 * 
	 * @param app
	 *            The running frame Application
	 * @return an integer that indicates the number of loop to delete from
	 *         Primitive.stackLoop
	 * @throws LogoError
	 */
	private void eraseLevelReturn(Application app) throws LogoError
	{
		boolean error = true;
		String caractere = "";
		int loopLevel = 0;
		int marqueur = 0;
		InstructionBuffer instruction = app.getKernel().getInstructionBuffer();
		for (int i = 0; i < instruction.getLength(); i++)
		{
			caractere = String.valueOf(instruction.charAt(i));
			if (caractere.equals(Primitive.END_PROCEDURE))
			{
				marqueur = i;
				error = false;
				break;
			}
			else if (caractere.equals(Primitive.END_LOOP))
			{
				/*
				 * On test si le caractère "\" est bien un caractère de fin
				 * de boucle et non du style "\e" ou "\#"
				 */
				if (instruction.charAt(i + 1) == ' ')
				{
					loopLevel++;
				}
			}
		}
		if (error) { throw new LogoError(Logo.messages.getString("erreur_retourne")); }
		if (marqueur + 2 > instruction.getLength())
			instruction = new InstructionBuffer(" ");
		else
			instruction.delete(0, marqueur + 2);
		for (int i = 0; i < loopLevel; i++)
		{
			Primitive.stackLoop.pop();
		}
	}
	
	private void exportPrimCSV()
	{
		StringBuffer sb = new StringBuffer();
		Locale locale = new Locale("fr", "FR");
		ResourceBundle prim_fr = ResourceBundle.getBundle("primitives", locale);
		locale = new Locale("en", "US");
		ResourceBundle prim_en = ResourceBundle.getBundle("primitives", locale);
		locale = new Locale("ar", "MA");
		ResourceBundle prim_ar = ResourceBundle.getBundle("primitives", locale);
		locale = new Locale("es", "ES");
		ResourceBundle prim_es = ResourceBundle.getBundle("primitives", locale);
		locale = new Locale("pt", "BR");
		ResourceBundle prim_pt = ResourceBundle.getBundle("primitives", locale);
		locale = new Locale("eo", "EO");
		ResourceBundle prim_eo = ResourceBundle.getBundle("primitives", locale);
		locale = new Locale("de", "DE");
		ResourceBundle prim_de = ResourceBundle.getBundle("primitives", locale);
		// locale=new Locale("nl","NL");
		ResourceBundle[] prim = { prim_fr, prim_en, prim_es, prim_pt, prim_ar, prim_eo, prim_de };
		try
		{
			BufferedReader bfr = new BufferedReader(new InputStreamReader(
					Primitive.class.getResourceAsStream("genericPrimitive")));
			int i = 0;
			while (bfr.ready())
			{
				String line = bfr.readLine();
				StringTokenizer cut = new StringTokenizer(line);
				String cle = cut.nextToken();
				parametres[i] = Integer.parseInt(cut.nextToken());
				if (i != 39 && i != 95 && i != 212 && cle.length() != 1)
				{
					sb.append("$");
					sb.append(cle);
					sb.append("$");
					sb.append(";");
					for (int j = 0; j < prim.length; j++)
					{
						String txt = cle;
						txt = prim[j].getString(cle);
						sb.append("$");
						sb.append(txt);
						sb.append("$");
						sb.append(";");
					}
					sb.append("\n");
				}
				i++;
			}
			Utils.writeLogoFile("/home/loic/primTable.csv", new String(sb));
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
	
	private void exportMessageCSV()
	{
		StringBuffer sb = new StringBuffer();
		Locale locale = new Locale("fr", "FR");
		ResourceBundle lang_fr = ResourceBundle.getBundle("langage", locale);
		locale = new Locale("en", "US");
		ResourceBundle lang_en = ResourceBundle.getBundle("langage", locale);
		locale = new Locale("ar", "MA");
		ResourceBundle lang_ar = ResourceBundle.getBundle("langage", locale);
		locale = new Locale("es", "ES");
		ResourceBundle lang_es = ResourceBundle.getBundle("langage", locale);
		locale = new Locale("pt", "BR");
		ResourceBundle lang_pt = ResourceBundle.getBundle("langage", locale);
		locale = new Locale("eo", "EO");
		ResourceBundle lang_eo = ResourceBundle.getBundle("langage", locale);
		locale = new Locale("de", "DE");
		ResourceBundle lang_de = ResourceBundle.getBundle("langage", locale);
		// locale=new Locale("nl","NL");
		ResourceBundle[] lang = { lang_fr, lang_en, lang_es, lang_pt, lang_ar, lang_eo, lang_de };
		try
		{
			Enumeration<String> en = lang_fr.getKeys();
			while (en.hasMoreElements())
			{
				String cle = en.nextElement();
				sb.append("$");
				sb.append(cle);
				sb.append("$");
				sb.append(";");
				for (int j = 0; j < lang.length; j++)
				{
					String txt = lang[j].getString(cle);
					sb.append("$");
					sb.append(txt);
					sb.append("$");
					if (j != lang.length - 1)
						sb.append(";");
				}
				
				sb.append("\n");
			}
			Utils.writeLogoFile("/home/loic/messageTable.csv", new String(sb));
		}
		catch (Exception e)
		{
			e.printStackTrace();
		}
	}
	
	public static int isPrimitive(String s)
	{
		String index = Primitive.primitives.get(s.toLowerCase());
		if (null == index)
			return -1;
		try
		{
			int id = Integer.parseInt(index);
			return id % Primitive.PRIMITIVE_NUMBER;
		}
		catch (NumberFormatException e)
		{
			System.err.println("!!!!!!!!!!!!!!!!!!!!!!!!!!\n"
					+ "The file xlogo/kernel/genericPrimitive has been corrupted...\n"
					+ " Please, check the integrity of xlogo.jar \n!!!!!!!!!!!!!!!!!!!!!!!!!");
		}
		return -1;
	}
	
}