#! /usr/bin/env python2

"""
Installation instructions: Place this script in your path and make it
executable with "chmod +x labelxy" (without the quotes).  If it
complains you don't have "python" try changing "python" to "python3"
in the first line of this file.


For usage instructions, see below.

Version 1.2 of 2020/9/29

By Nathan Dunfield : http://dunfield.info

This code is in the public domain.  
"""

help_str = r"""Usage:   labelxy file

where file in ".eps" file, a ".pdf" file, or bitmap file such as ".png", ".jpg", etc.

A window will appear with image, and simply click on it to generate
the label locations, which are output on the terminal window.  The
resulting LaTeX code is intended for use with the following macros:

  % Based on the xypic import facility.  
  \usepackage[all,import,rotate]{xy}
  
  % Nathan's basic label overlay environment.   The usual version is the second one
  % below.  Args are: coor system, graphics modifiers, graphics name
  
  \newenvironment{xyoverpic}[3]
  {%
  \begin{xy}
  \xyimport#1{\includegraphics[#2]{#3}}
  }{\end{xy}}

  % Version that automatically centers the image.
  
  \newenvironment{cxyoverpic}[3]
  {%
  \centering \leavevmode
  \begin{xyoverpic}{#1}{#2}{#3}
  }{\end{xyoverpic}}

Requirements:

 * Python with Tkinter.  
 * GhostScript.

On OS X, the is first built in and the others are included with the
MacTeX-2010 distribution: http://www.tug.org/mactex/

On Linux, are all available as standard packages, with the first
called "python-tk" or "python3-tk" on Ubuntu/Debian and "tkinter" on
Fedora.
"""

prefix_text_1 = r"""% Click on the window that appeared to generate the label
% locations.  When you're done, close the window and then 
% copy everything into your LaTeX file.
"""

prefix_text_2 = r"""
\begin{figure}[htb]
\begin{cxyoverpic}{(%d,%d)}{scale=1.0}{%s}"""

suffix_text =  "\\end{cxyoverpic}\n  \\caption{}\n  \\label{fig-}\n\\end{figure}"

import os, sys, tempfile
from optparse import OptionParser

from string import ascii_letters as letters

try:
    import tkinter
except ImportError:
    import Tkinter as tkinter

def is_postscript_file(file_name):
    return os.path.splitext(file_name)[-1].lower() in ['.eps','.pdf']

def convert_file_to_bitmap(in_file, out_file, pixels_per_pt=1):
    # If it's PostScript-based, use GhostScript to convert to a bitmap.
    if is_postscript_file(in_file):
        os.system("gs -sDEVICE=ppmraw -dEPSCrop -dNOPAUSE -dBATCH -dSAFER -q " +
                  "-dAlignToPixels=0 -dTextAlphaBits=4 -dUseCropBox -dGraphicsAlphaBits=4 " + 
                  "-r%d -sOutputFile=%s %s" % (72*pixels_per_pt, out_file, in_file))
    else:
        # Use ImageMagick and pray.
        os.system("convert %s %s" % (in_file, out_file))

        
def label_file(file_to_label):
    # Start Tk
    root = tkinter.Tk()

    # Load the image file
    base_name = os.path.splitext(file_to_label)[0]
    image_file = tempfile.mktemp() + ".ppm"
    pixels_per_pt = 2 if is_postscript_file(file_to_label) else 1
    convert_file_to_bitmap(file_to_label, image_file, pixels_per_pt)
    tkpi = tkinter.PhotoImage(file=image_file)

    W, H = tkpi.width(), tkpi.height()
    w, h = W/pixels_per_pt, H/pixels_per_pt
  
    # Print the inital TeX code 
    print( prefix_text_1 + prefix_text_2 % (w, h, base_name) )

    # Start Tk

    root.geometry('+%d+%d' % (100,100))
    root.geometry('%dx%d' % (W, H))
    
    image_canvas = tkinter.Canvas(root, width=W, height=H, bd=0, highlightthickness=0)
    image_canvas.create_image( (0,0), anchor="nw", image=tkpi)
    image_canvas.circle_count = 0
    
    def process_click(event):
        x, y = event.x, event.y
        r = 6
        print( "    ,(%d,%d)*{%s}" % (x/pixels_per_pt, h - y/pixels_per_pt,
                                      letters[image_canvas.circle_count % len(letters)]) )
        image_canvas.create_oval(x-r, y-r, x+r, y+r,outline="black", fill="red")
        image_canvas.circle_count += 1
        
    image_canvas.bind("<Button>", process_click)
    image_canvas.place(x=0, y=0)
    image_canvas.pack()
    root.title(base_name)
    root.mainloop()

    # Print the rest of the TeX code and clean up
    print( suffix_text  )
    os.remove(image_file)

if __name__ == "__main__":
    parser = OptionParser()
    parser.set_usage(help_str)
    options, args = parser.parse_args()
    if len(args) == 0:
        print( "Sorry, no file specified." )

    for file_to_label in args:
        if not os.path.exists(file_to_label):
            print( "Sorry, the file you specified (%s) does not exist." % file_to_label)
        else:
            label_file(file_to_label)