Update: Most of the post ramains true, but make sure you download these scripts from the SF.net repository.

In this post I want to share three scripts that can do an extended search and replace in OmegaT project. Search and replace templates for each script are specified in external plain text files located in project’s root folder, so these scripts without any modifications can be used for different projects with different sets of search and replace patterns — the user needs to modify only those plain text files as needed. On top of text modification there is a possibility to do a simple math on what is being found by the script thus enabling the user to have a per project unit converter.
Each script should be accompanied by its own external file located in a subfolder named .ini in the project’s root (details under each script further on). The format of these files is the same for all three:

• Only one empty line in the file — the very last one
• Each line consists of tree blocks:
  1. Search pattern (regex aware)
  2. Tab
  3. Replace pattern

So, if you need to replace “Владимир Владимирович” (taking into consideration different cases of Russian nouns) with “the President of Russian Federation“, here’s what you need to specify in the substitution file:
Владимир\p{L}?+\sВладимирович\p{L}?+ the President of Russian Federation
If you need to convert miles into kilometers, here’s what you specify:
(\d+)(\s?)mile(s?) ${(it[1] as int) * 1.6}$2km
Likewise, if you want to convert Fahrenheit into Centigrade, here’s the line:
(\d+)°F ${((it[1] as int) - 32 ) * 5 / 9 }°C
To make sure abbreviation “EU” is always spelled in uppercase, you can either put:
\b([Ee][Uu])\b ${(it[1] as String).toUpperCase()}
or
\b([Ee][Uu])\b EU
There’s a TAB character in each of the above examples. It separates search pattern from replace pattern.

So, now to the scripts themselves. As usual, each heading is a link to pastebin.com where you can download the scripts, and under each heading there is a listing of the script.

• search_replace_batch.groovy

  /*
   * #Purpose:     Batch search and replace in the whole project
   * #Files:       Requires 'search_replace.ini' in the current project's root
   * #File format: Plain text, where *each* line is:
   *    [Search Pattern] [Tab] [Replace Pattern];
   *    only the last line *must* be empty.
   * #Details:     http: // wp.me/p3fHEs-5e
   *
   *
   * @author  Kos Ivantsov
   * @based on Didier Briel's "search and replace script"
   * @date    2013-07-22
   * @version 0.1
   */
  
  import static javax.swing.JOptionPane.*
  import static org.omegat.util.Platform.*
  import groovy.swing.SwingBuilder
  import java.awt.Component
  import javax.swing.JButton
  import javax.swing.JTable
  import javax.swing.table.*
  import javax.swing.event.*
  import java.awt.event.*
  import java.awt.BorderLayout as BL
  
  /*
   * set 'GUI' to anything but 'true' (with quotes) in the next line
   * if you don't need a GUI listing of all changed segments
   */
  def GUI = 'true'
  
  def prop = project.projectProperties
  if (!prop) {
    final def title = 'Batch search and replace'
    final def msg   = 'Please try again after you open a project.'
    showMessageDialog null, msg, title, INFORMATION_MESSAGE
    return
  }
  
  //def folder = prop.projectRoot
  //def fileloc = folder+'/subst_template.txt'
  subst_file = new File(prop.projectRoot+'/search_replace.ini')
  
  if (! subst_file.exists()) {
  	final def title = 'No file'
  	final def msg   = 'Template file for batch search and replace'+'\n' + subst_file +'\n'+'doesn\'t exist.'
  	showMessageDialog null, msg, title, INFORMATION_MESSAGE
  	return
  	}
  
  length = subst_file.readLines().size()
  search_array = []
  replace_array = []
  data = []
  def count = 0 
  
  while ( count
  	source = ste.getSrcText();
  	target = project.getTranslationInfo(ste) ? project.getTranslationInfo(ste).translation : null;
  	initial_target = target
  
  	// Skip untranslated segments
  	if (target == null) return
  
  	for ( i in range) {
  		ser = search_array[i]
  		rep = (replace_array[i] =~ /\$(\d+)/ ).replaceAll( '\\${(it[$1] as String) }' )
  		shell = new GroovyShell()
  		eval = {statement, arg -> shell.setVariable 'it', arg; shell.evaluate '"' + statement + '"' }
  		target = target.replaceAll(/null/, 'repl0')
  		target = target.replaceAll(ser) { eval rep, it }
  		target = target.replaceAll(/null/, '')
  		target = target.replaceAll(/repl0/, 'null')
  		}
  
  	if (initial_target != target) {
  		data.add([ seg: ste.entryNum(), source: source, in_target: initial_target, target: target ])
  		segment_count++
  		editor.gotoEntry(ste.entryNum())
  		console.println(ste.entryNum() + "\t" + ste.srcText + "\t" + target )
  		editor.replaceEditText(target)
  	}
  }
  
  swing = new SwingBuilder()
  frame = swing.frame(title:'Changed segments', preferredSize: [1024, 500]) {
  	scrollPane {
  		table() {
  			tableModel(list:data) {
  				propertyColumn(editable: true, header:'Segment', propertyName:'seg', minWidth: 80, maxWidth: 80, preferredWidth: 80,
  						cellEditor: new TableCellEditor()
  						{
  							public void cancelCellEditing()	{}
  							public boolean stopCellEditing()	{   return false;   }
  							public Object getCellEditorValue()	{   return value;   }
  							public boolean isCellEditable(EventObject anEvent)	{   return true;    }
  							public boolean shouldSelectCell(EventObject anEvent)	{return true; }
  							public void addCellEditorListener(CellEditorListener l)	{}
  							public void removeCellEditorListener(CellEditorListener l)	{}
  							public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)
  							{
  								println("value: " + value);
  								org.omegat.core.Core.getEditor().gotoEntry(value);
  							}
  
  						},
  						cellRenderer: new TableCellRenderer()
  						{
  							public Component getTableCellRendererComponent(JTable table,
  							Object value,
  							boolean isSelected,
  							boolean hasFocus,
  							int row,
  							int column)
  							{
  								def btn = new JButton()
  								btn.setText(value.toString())
  								return btn
  
  							}
  						}
  						)
  				propertyColumn(editable: false, header:'Source',propertyName:'source', minWidth: 150, preferredWidth: 350)
  				propertyColumn(editable: false, header:'Initial Target',propertyName:'in_target', minWidth: 150, preferredWidth: 350)
  				propertyColumn(editable: false, header:'Target',propertyName:'target', minWidth: 150, preferredWidth: 350)
  			}
  		}
  
  	}
  	 panel(constraints: BL.SOUTH){
  			button('Quit', actionPerformed:{
  				frame.visible = false
  			})
  		}
  }
  
  console.println "\n${'-'*10}"+"\n"+"Segments modified: " + segment_count
  if (segment_count == 0){
  	final def title = 'Search and Replace'
  	final def msg   = 'No segments can be changed.'
  	showMessageDialog null, msg, title, INFORMATION_MESSAGE
  	return
  }
  
  if (GUI == 'true') {
  	if (segment_count != 0){
  	frame.pack()
  	frame.show()
  		}
  	}
  

  This script performs a global search and replace in the whole project. The file where search and replace patterns are specified should be named search_replace.ini. The sequence in which these patterns are listed matters. You should back up your project before using the script, as there’s no way to revert the changes.

• search_replace_pretranslate.groovy

  /*
   * #Purpose:    Pretranslate certain untranslated segments
   * #Files:    Requires 'pretranslate.ini' .ini subfolder of the current project's root
   * #File format:    Plain text, where *each* line is:
   *    [Search Pattern] [Tab] [Replace Pattern];
   *    only the last line *must* be empty.
   * #Note:    Only those segment where a [Search Pattern] is found,
   *    are pretranslated and prefixed with {PRETRAN}
   * #Details:    http://wp.me/p3fHEs-5e
   *
   * @author    Kos Ivantsov
   * @author    Yu Tang
   * @based on Didier Briel's "search and replace script"
   * @date    2013-12-28
   * @version 0.2
   */
  
  import static javax.swing.JOptionPane.*
  import static org.omegat.util.Platform.*
  import groovy.swing.SwingBuilder
  import java.awt.Component
  import javax.swing.JButton
  import javax.swing.JTable
  import javax.swing.table.*
  import javax.swing.event.*
  import java.awt.event.*
  import java.awt.BorderLayout as BL
  
  /*
   * set 'GUI' to anything but 'true' (with quotes) in the next line
   * if you don't need a GUI listing of all changed segments
   */
  def GUI = 'true'
  
  /*
   * set true to process current document only,
   * otherwise process whole project.
   */
  def CURRENT_FILE_ONLY = false
  
  def prop = project.projectProperties
  if (!prop) {
      final def title = 'Pretranslate'
      final def msg   = 'Please try again after you open a project.'
      showMessageDialog null, msg, title, INFORMATION_MESSAGE
      return
  }
  
  subst_file = new File(prop.projectRoot, '.ini/pretranslate.ini')
  
  if (! subst_file.exists()) {
      final def title = 'No file'
      final def msg   = 'Template file for pretranslation'+'\n' + subst_file +'\n'+'doesn\'t exist.'
      showMessageDialog null, msg, title, INFORMATION_MESSAGE
      return
  }
  
  length = subst_file.readLines().size()
  search_array = []
  replace_array = []
  data = []
  def count = 0 
  
  while ( count
      // Skip translated segments
      if (project.getTranslationInfo(ste).translation) {
          return
      }
  
      initial_target = target = source = ste.srcText
  
      for ( i in range) {
          ser = search_array[i]
          rep = (replace_array[i] =~ /\$(\d+)/ ).replaceAll( '\\${(it[$1] as String) }' )
          shell = new GroovyShell()
          eval = {statement, arg -> shell.setVariable 'it', arg; shell.evaluate '"' + statement + '"' }
          target = target.replaceAll(/null/, 'repl0')
          target = target.replaceAll(ser) { eval rep, it }
          target = target.replaceAll(/null/, '')
          target = target.replaceAll(/repl0/, 'null')
      }
  
      if (initial_target != target) {
          data.add([ seg: ste.entryNum(), source: source, in_target: initial_target, target: target ])
          segment_count++
          editor.gotoEntry(ste.entryNum())
          console.println(ste.entryNum() + "\t" + ste.srcText + "\t" + target )
          target = target.replaceAll(/(^)/, '\\{PRETRAN\\}$1')
          editor.replaceEditText(target)
      }
  }
  
  swing = new SwingBuilder()
  frame = swing.frame(title:'Changed segments', preferredSize: [1024, 500]) {
      scrollPane {
          table() {
              tableModel(list:data) {
                  propertyColumn(editable: true, header:'Segment', propertyName:'seg', minWidth: 80, maxWidth: 80, preferredWidth: 80,
                          cellEditor: new TableCellEditor()
                          {
                              public void cancelCellEditing()    {}
                              public boolean stopCellEditing()    {   return false;   }
                              public Object getCellEditorValue()    {   return value;   }
                              public boolean isCellEditable(EventObject anEvent)    {   return true;    }
                              public boolean shouldSelectCell(EventObject anEvent)    {return true; }
                              public void addCellEditorListener(CellEditorListener l)    {}
                              public void removeCellEditorListener(CellEditorListener l)    {}
                              public Component getTableCellEditorComponent(JTable table, Object value, boolean isSelected, int row, int column)
                              {
                                  println("value: " + value);
                                  org.omegat.core.Core.editor.gotoEntry value
                              }
  
                          },
                          cellRenderer: new TableCellRenderer()
                          {
                              public Component getTableCellRendererComponent(JTable table,
                              Object value,
                              boolean isSelected,
                              boolean hasFocus,
                              int row,
                              int column)
                              {
                                  def btn = new JButton()
                                  btn.setText(value.toString())
                                  return btn
                              }
                          }
                          )
                  propertyColumn(editable: false, header:'Source',propertyName:'source', minWidth: 150, preferredWidth: 350)
                  propertyColumn(editable: false, header:'Initial Target',propertyName:'in_target', minWidth: 150, preferredWidth: 350)
                  propertyColumn(editable: false, header:'Target',propertyName:'target', minWidth: 150, preferredWidth: 350)
              }
          }
  
      }
      panel(constraints: BL.SOUTH){
          button('Quit', actionPerformed:{
              frame.dispose()
          })
      }
  }
  
  console.println "\n${'-'*10}"+"\n"+"Segments modified: " + segment_count
  
  if (segment_count == 0){
      final def title = 'Pretranslate'
      final def msg   = 'No segments can be pretranslated.'
      showMessageDialog null, msg, title, INFORMATION_MESSAGE
      return
  }
  
  if (GUI == 'true' && segment_count) {
      frame.pack()
      frame.show()
  }
  

  The external file for this script should be named pretranslate.ini. This script works only on those segments that don’t have translation. If the source segment contains what is specified as a search pattern, then target gets populated with the source text with all the possible substitutions and prefixed with {PRETRAN}. Other segments where nothing was found are left intact.

• replace_with_template.groovy

  /* :name=Autotext :description=Text manipulations in the current segment
   * Purpose: Modify current target sequentially replacing [Search patterns]
   * with [Replace patterns], specified in external file
   * #Files: Requires 'segment_substitution.ini' in '.ini' subfolder
   * of the current project's root
   * #Format: Plain text, where *each* line is:
   * [Search Pattern] [Tab] [Replace Pattern];
   * only the last line *must* be empty.
   * #Details: http://wp.me/p3fHEs-5e
   *
   * @author Kos Ivantsov (with major contributions by Yu Tang)
   * @date 2014-05-30
   * @version 0.4
   */
  
  import static javax.swing.JOptionPane.*
  import static org.omegat.util.Platform.*
  
  def prop = project.projectProperties
  if (!prop) {
   final def title = 'Replace using substitution file'
   final def msg = 'Please try again after you open a project.'
   showMessageDialog null, msg, title, INFORMATION_MESSAGE
   return
  }
  
  def folder = prop.projectRoot
  def fileloc = folder+'.ini/segment_substitution.ini'
  subst_file = new File(fileloc)
  
  if (! subst_file.exists()) {
   final def title = 'No file'
   final def msg = 'Substitution file ' + subst_file + ' doesn\'t exist.'
   showMessageDialog null, msg, title, INFORMATION_MESSAGE
   return
   }
  
  length = subst_file.readLines().size()
  search_array = []
  replace_array = []
  def count = 0
  
  while ( count < length ) {
   ln = subst_file.readLines().get(count).tokenize('\t')
   sr = ln[0]
   rp = ln[1]
   search_array.add(sr)
   replace_array.add(rp)
   count++
   }
  
  def range = 0.. shell.setVariable 'it', arg; shell.evaluate '"' + statement + '"' }
   target = target.replaceAll(/null/, 'repl0')
   target = target.replaceAll(ser) { eval rep, it }
   target = target.replaceAll(/null/, '')
   target = target.replaceAll(/repl0/, 'null')
   }
  
  if (editor.selectedText){
   editor.insertText(target)
   }else
  editor.replaceEditText(target)
  

  This one needs a plain text file named segment_substitution.ini. I published it before, but here I include it with some additions and enhancements. This script works only on the current segment. One of the things it can be used for is inserting additional characters not present in you keyboard layout (even though I’m not a big supporter of such use). So, if you need to insert a copyright symbol, you may specify the following line:
  \*co\* ©
  which will substitute “*co*” with “©“.
  You can also use it for something like autotext function. You can specify your own abbreviation and the way they should expand. Being able to use regex allows one to do nifty things for languages where you need to take care of word cases. Here’s an example:
  I want to be able to insert a compound term using my own abbreviation. Each part of the term should agree in number and case. The term is “Провідний регіональний cлюсар-сантехнік” (Just-made-up Ukrainian term that means “Lead regional fitter-plumber”)
  The line can look like this:
  \b([Пп])н(\p{L}+)-р(\p{L}+)?-к(\p{L}+)? $1ровідн$2 регіональн$2 слюсар$3-сантехнік$4
  When I type “пний-р-к” and invoke the script, it will be expanded into “провідний регіональний слюсар-сантехнік“. If I start that abbreviation with uppercase, the expended line will start with uppercase too. And then I can relatively easy use cases: “Пними-рями-ками” will expand into “Провідними регіональними слюсарями-сантехніками“. It’s rather geeky, I realize that, but it just shows that it can be used for a number of things.

  UPDATE: This script has been updated on October 15, 2013 (the listing here and on pastebin.com are up to date, you may need to update your local copy)

  The update includes new location of the segment_substitution.ini, and new behavior when the script is invoked while some text is selected  — the selection gets inserted into the target at the cursor position after all the possible transformations. If no transformations are possible, the text inserts as is, which might be a nifty way to insert things without changing your clipboard content.

Big thanks goes to Yu Tang who helped me figure out how to make math possible in these scripts.

But as of now,
Good luck