Indesign Script - GREP-Fundstellen auflisten

Gerd fragte in seinem Beitrag nach der Einlösung des Versprechens, etwas Ähnliches für die Treffer von GREP-Suchvorgängen zu entwickeln.

Auf der Basis von listHyphenedWords.jsx hier nun eine Studie zum Auflisten von GREP-Fundstellen.

Vorbereitung
Das Skript greift auf die Suchkriterien in der GREP-Suchen Palette zurück (ich wollte das Rad mit all seinen Einstellungsmöglichkeiten nicht für einen komplexen Dialog neu erfinden).
Dort sind die zu suchenden Eigenschaften (z.B. \<\w*f[li]\w*\> (Format suchen: + Ligatur) für die Suche nach Wörtern mit fl- und fi-Ligaturen) vor dem Start des Skripts einzutragen.

Der für die Suche angegebene GREP-Ausdruck wird in der Palette in einem editierbaren Textfeld angezeigt.
Dort kann der GREP-Ausdruck geändert werden.
Nach Bestätigung der Änderung mit Return wird die Suche mit diesem (veränderten) GREP ausgeführt.

Beim Start des Skripts wird ein Suchbereich ermittelt.
– Nichts ausgewählt: durchsuche das gesamte Dokument
– Text oder Textrahmen ausgewählt: nach Betätigung Suche beschränken auf ausgewählten Text bzw. Textrahmen
– Einfügemarke platziert: nach Bestätigung Suche beschränken auf ausgewählten Textabschnitt.

Dieser Suchbereich wird in der Palette oben eingeblendet.
Solange die Palette geöffnet ist und das Skript nicht neu gestartet wurde, bleibt dieser Suchbereich gültig, auch wenn sich inzwischen – etwa durch Sprung zu einem Treffer – die Auswahl verändert hat!

Das Skript listet die Treffer (mit vorangestellter Angabe der Seite) auf.
Ein Mausklick auf einen Treffer in der Palette zoomt die Fundstelle heran.

Es ist möglich, dass sich Änderungen im Text (z.B. an der Fundstelle) störend auf die Adressierung der Fundstelle aus der Palette heraus auswirken können. Das wird sich in der Praxis zeigen. ;-)

// listGrepFounds.jsx   
   
//DESCRIPTION:Listet die Ergebnisse einer GREP-Suche mit den Einstellungen in der GREP-Palette in einer Palette auf   
//Author: Martin Fischer   
//Mai 2010   
//März 2011 geringfügige Änderung bzgl. des Verhaltens auf eine Auswahl (Bestätigung eingebunden)
#targetengine "session"   
   
// ----------------------------------------------------------------------------------------    
//                                  Voreinstellungen   
// ----------------------------------------------------------------------------------------    
try  
{ 
	a_palette.close(); 
} catch(e) {}

var a_palette = main();

function main()
{
	var doc = app.activeDocument;   
	   
	// ausgewählter Textabschnitt oder alle Textabschnitte   
	var the_stories = (app.selection.length == 0 || !(app.selection[0].hasOwnProperty('baseline') || app.selection[0] instanceof TextFrame) )
		? doc.stories.everyItem().getElements()
		: confirm_sel(doc);
		   
	var the_zoom = 200;   
	   
	// Arrays für die Liste in der Palette (mit verknüpftem Objekt)   
	var obj_array = new Array;   
	var content_array = new Array;

var data = walk_trough(the_stories, obj_array, content_array);

// ----------------------------------------------------------------------------------------    
	//                                  Ausgabe/Darstellung in der Palette   
	// ----------------------------------------------------------------------------------------    
	if (obj_array.length > 0)   
	{
		var a_palette = the_result_panel ( data.obj, data.content );   
		writeTXT(data.content.join('\r'));
	}
	else   
		alert('Nix gefunden!');   
	return a_palette;
 }  
// ===============================================================   
//                                  Funktionen   
// ===============================================================   
   
function confirm_sel(doc)
{
	var the_stories = (confirm('Nur ausgewählter Textabschnitt?') == true)
	? [app.selection[0].parentStory]
	: doc.stories.everyItem().getElements();
	return the_stories;
}

// ----------------------------------------------------------------------------------------    
//                                  Marsch durch die Textabschnitte   
// ----------------------------------------------------------------------------------------    
function walk_trough(the_stories, obj_array, content_array)
{
	for ( var s = 0; s < the_stories.length; s++ )    
	{     
		var the_result = checkText(the_stories[s]);   
		for ( var i = 0; i < the_result.objects.length; i++ )    
		{   
			obj_array.push(the_result.objects[i]);   
			content_array.push(the_result.contents[i]);   
		}   
	}   
	return {obj:obj_array, content: content_array};
}

// ----------------------------------------------------------------------------------------   
//                                  Erforschung eines Bereichs nach Treffern   
// ----------------------------------------------------------------------------------------   
function checkText(the_range)   
{   
    var temp_contents = new Array;   
    var temp_tobj = new Array; 
    // Prüfen, ob Suchkriterien gegeben sind 
    try 
    { 
        var result = the_range.findGrep(); 
    } 
    catch (e) 
    { 
        alert('Bitte Suchkriterien in der GREP-Suchpalette eintragen!'); 
        exit(); 
    } 
    for ( var p = 0; p < result.length; p++ )   
    { 
        var my_page = find_page(result[p]); 
        // Fundstellen in Überlauf rausfiltern 
        if (my_page != null) 
        { 
            temp_tobj.push(result[p]); 
            temp_contents.push('S. ' + my_page.name + ':  ' + result[p].contents);   
        } 
    } 
    return ({objects:temp_tobj, contents:temp_contents})   
}   
   
// ----------------------------------------------------------------------------------------   
//                                  Objekt auswählen und heranzoomen   
// ----------------------------------------------------------------------------------------   
function selectIt ( the_obj )    
{     
    // Selects object, turns to page and zooms in on it     
	var the_zoom = app.activeWindow.zoomPercentage; 
    if (the_obj != null)   
    {   
        app.select ( the_obj,SelectionOptions.replaceWith ) ;     
        app.activeWindow.zoomPercentage = the_zoom;     
    }   
    else // Verabschiedung   
    {   
        alert('Wort mehr greifbar!');   
        a_palette.close();   
    }   
}    
   
// ----------------------------------------------------------------------------------------   
//                                              Ergebnispalette   
// ----------------------------------------------------------------------------------------   
function the_result_panel ( obj_array, content_array)    
{   
    // Maße für die Listenboxen   
    var p_height = 900;    
    var p_width = 350;   
    // erzeuge Palette mit Titel   
	if (a_palette == undefined)
		var a_palette = new Window ( 'palette {properties:{ closeOnKey:’OSCmnd+W’, resizeable:false, maximizeButton:false, minimizeButton:false , closeButton:true}}', 'Fundstellen' ) ;      
 
    with ( a_palette )    
    {   
        window.orientation = 'row';   
        window.alignment = 'top';   
        location = [app.activeDocument.layoutWindows.firstItem().bounds[3]-p_width-50, app.activeDocument.layoutWindows.firstItem().bounds[0] +17];   
   
        gr = add ( 'group' ) ;   
        gr.orientation = 'column';   
        gr.edit_text = gr.add ( 'editText', [0,0,p_width,25], app.findGrepPreferences.findWhat , {enterKeySignalsOnChange:true}) ;   
        gr.lb_text = gr.add ( 'listbox', [0, 0, p_width, p_height], '', {items : content_array } ) ;

// Reaktion auf Änderung im editText-Feld  
        gr.edit_text.onChange = function ()    
        {    
			app.findGrepPreferences.findWhat = gr.edit_text.text;
			close();
			main();
        }     
        // Reaktion auf Wechsel der Auswahl in der Liste   
        gr.lb_text.onChange = function ()    
        {    
            if ( this.selection != null )    
               selectIt ( obj_array [ this.selection.index] ) ;   
        }   
   
        // zeige die Palette an   
        show () ;          
    }   
    return a_palette;   
} 
 
function find_page(theObj)  
{  
    var thePage = theObj;  
    if (thePage.hasOwnProperty("baseline"))  
    {  
        thePage = thePage.parentTextFrames[0];  
        if (thePage == null) {return null }  
    }  
    while (thePage.constructor.name != "Page")  
    {  
        var whatIsIt = thePage.constructor.name;  
        switch (whatIsIt)  
        {  
            case  "Character" :  
                thePage = thePage.parentTextFrames[0];  
                break;  
            case  "Spread" :  
                thePage = thePage.pages[0]; 
                return thePage;  
            case "Application" :  
                // must be off page, so ignore  
                return null;  
        }  
        thePage = thePage.parent;  
    }  
    return thePage  
}

// -----------------------------------------------------------------------------------------------------------------
//												config.txt schreiben
// -----------------------------------------------------------------------------------------------------------------
function writeTXT ( myData )
{
	var theDir = '~/Desktop';
	var f = new File( theDir + '/GREP.txt' );
	f.open( 'w' );
	f.encoding = 'UTF-8';
	f.writeln ( myData );
	f.close();
	f.execute();
}