com.mewmew.fairy.v1.cli.AnnotatedCLI.java Source code

Java tutorial

Introduction

Here is the source code for com.mewmew.fairy.v1.cli.AnnotatedCLI.java

Source

/*
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at
    
http://www.apache.org/licenses/LICENSE-2.0
    
  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
*/
package com.mewmew.fairy.v1.cli;

import com.google.common.base.Supplier;
import com.google.common.collect.Maps;
import com.google.common.collect.Multimap;
import com.google.common.collect.Multimaps;
import org.apache.commons.cli.CommandLine;
import org.apache.commons.cli.GnuParser;
import org.apache.commons.cli.HelpFormatter;
import org.apache.commons.cli.Options;
import org.apache.commons.cli.ParseException;
import sun.misc.Unsafe;

import java.lang.reflect.Field;
import java.lang.reflect.Constructor;
import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Stack;
import java.util.Map;
import java.util.HashMap;

/*
 * Lots of magic in here. You probably don't want to read it. Just treat this as a black box.
 * This is looking more and more like Guice...
 */
public class AnnotatedCLI {
    final Options options;
    final Multimap<Class, AnnotatedOption> mappings;
    final Map<Class, Field> args = new HashMap<Class, Field>();
    final Map<Class, AnnotatedConstructor> ctors = new HashMap<Class, AnnotatedConstructor>();
    final Unsafe unsafe = stealUnsafe();
    final StringParsers parsers = new StringParsers();

    public AnnotatedCLI(Class... clazz) {
        final List<AnnotatedOption> list = new ArrayList<AnnotatedOption>();
        for (Class aClass : clazz) {
            for (Field field : aClass.getDeclaredFields()) {
                Param param = field.getAnnotation(Param.class);
                if (param != null) {
                    list.add(new AnnotatedOption(aClass, field, param));
                }
                Args arg = field.getAnnotation(Args.class);
                if (arg != null) {
                    args.put(aClass, field);
                }
            }
            for (Constructor ctor : aClass.getConstructors()) {
                AnnotatedConstructor actor = new AnnotatedConstructor(aClass, ctor);
                Class[] types = ctor.getParameterTypes();
                Annotation[][] annotations = ctor.getParameterAnnotations();
                for (int i = 0; i < types.length; i++) {
                    Class type = types[i];
                    Annotation[] ann = annotations[i];
                    for (Annotation annotation : ann) {
                        if (annotation instanceof Param) {
                            actor.addParam((Param) annotation, type);
                        }
                    }
                }
                if (actor.isValid()) {
                    ctors.put(aClass, actor);
                }
            }
        }
        options = new Options();
        mappings = Multimaps.newMultimap(Maps.<Class, Collection<AnnotatedOption>>newHashMap(),
                new Supplier<Collection<AnnotatedOption>>() {
                    public Collection<AnnotatedOption> get() {
                        return new ArrayList<AnnotatedOption>();
                    }
                });
        for (AnnotatedConstructor constructor : ctors.values()) {
            for (AnnotatedConstructor.AnnotatedParam param : constructor.getParams()) {
                boolean hasArgs = !(param.getType().equals(boolean.class) || param.getType().equals(Boolean.class));
                String option = param.getParam().option();
                while (options.hasOption(option)) {
                    option = option + option;
                }
                options.addOption(option, param.getParam().name(), hasArgs, param.getParam().desc());
            }
        }
        for (AnnotatedOption opt : list) {
            boolean hasArgs = !(opt.field.getType().equals(boolean.class)
                    || opt.field.getType().equals(Boolean.class));
            while (options.hasOption(opt.getOpt())) {
                opt.setOpt(opt.getOpt() + opt.getOpt());
            }
            options.addOption(opt.getOpt(), opt.getName(), hasArgs, opt.getParam().desc());
            mappings.put(opt.clazz, opt);
        }
    }

    public static <T> AnnotatedCLI getMagicCLI(Class<T> c) {
        Stack<Class> stack = new Stack<Class>();
        Class p = c;
        while (p != Object.class) {
            stack.push(p);
            p = p.getSuperclass();
        }
        return new AnnotatedCLI(stack.toArray(new Class[stack.size()]));
    }

    public <T> T getInstance(Class<T> c, String[] args) throws Exception {
        AnnotatedConstructor ctor = ctors.get(c);
        AnnotatedCLI.ParsedCLI cli = parse(args);
        T obj;
        if (ctor != null) {
            obj = (T) ctor.newInstance(cli);
        } else {
            obj = (T) c.newInstance();
        }
        cli.inject(obj);
        return obj;
    }

    public AnnotatedCLI addParser(StringParser t) {
        parsers.addParser(t);
        return this;
    }

    private void magicallySetField(Object obj, Field field, Object value) {
        if (value == null) {
            return;
        }
        boolean wasInaccessible = !field.isAccessible();
        if (wasInaccessible) {
            field.setAccessible(true);
        }
        try {
            field.set(obj, value);
        } catch (IllegalAccessException e) {
            System.err.println("diving into unsafe territory !");
            long offset = unsafe.objectFieldOffset(field);
            if (value instanceof Integer) {
                unsafe.putInt(obj, offset, (Integer) value);
            } else if (value instanceof Long) {
                unsafe.putLong(obj, offset, (Long) value);
            } else if (value instanceof Boolean) {
                unsafe.putBoolean(obj, offset, (Boolean) value);
            } else if (value instanceof Float) {
                unsafe.putFloat(obj, offset, (Float) value);
            } else if (value instanceof Double) {
                unsafe.putDouble(obj, offset, (Double) value);
            } else if (value instanceof Byte) {
                unsafe.putByte(obj, offset, (Byte) value);
            } else if (value instanceof Character) {
                unsafe.putChar(obj, offset, (Character) value);
            } else if (value instanceof Short) {
                unsafe.putShort(obj, offset, (Short) value);
            } else {
                unsafe.putObject(obj, offset, value);
            }
        }
        field.setAccessible(!wasInaccessible);
    }

    public ParsedCLI parse(String... args) throws ParseException {
        return new ParsedCLI(new GnuParser().parse(options, args));
    }

    public void printHelp(String msg) {
        new HelpFormatter().printHelp(msg, options);
    }

    private static Unsafe stealUnsafe() {
        try {
            Class objectStreamClass = Class.forName("java.io.ObjectStreamClass$FieldReflector");
            Field unsafeField = objectStreamClass.getDeclaredField("unsafe");
            unsafeField.setAccessible(true);
            return (Unsafe) unsafeField.get(null);
        } catch (Exception e) {
            e.printStackTrace();
            throw new RuntimeException(e);
        }
    }

    public class ParsedCLI {
        final CommandLine cmd;

        ParsedCLI(CommandLine cmd) {
            this.cmd = cmd;
        }

        public ParsedCLI inject(Object obj) {
            if (obj instanceof ParserProvider) {
                StringParser[] p = ((ParserProvider) obj).getParsers();
                if (p != null) {
                    for (StringParser stringParser : p) {
                        cli().addParser(stringParser);
                    }
                }
            }
            Class clazz = obj.getClass();
            while (clazz != Object.class) {
                Collection<AnnotatedOption> opts = mappings.get(clazz);
                if (opts != null) {
                    for (AnnotatedOption opt : opts) {
                        if (cmd.hasOption(opt.getOpt())) {
                            if (opt.field.getType() == boolean.class || opt.field.getType() == Boolean.class) {
                                magicallySetField(obj, opt.field, true);
                            } else {
                                magicallySetField(obj, opt.field,
                                        parsers.parse(opt.field.getType(), cmd.getOptionValue(opt.getOpt())));
                            }
                        } else {
                            String defaultValue = opt.getParam().defaultValue();
                            if (defaultValue.length() > 0) {
                                magicallySetField(obj, opt.field, parsers.parse(opt.field.getType(),
                                        cmd.getOptionValue(opt.getOpt(), defaultValue)));
                            }
                        }
                    }
                }
                Field argField = args.get(clazz);
                if (argField != null) {
                    try {
                        magicallySetField(obj, argField, cmd.getArgs());
                    } catch (Exception e) {
                    }
                }
                clazz = clazz.getSuperclass();
            }
            return this;
        }

        public AnnotatedCLI cli() {
            return AnnotatedCLI.this;
        }
    }

    public Field getArgs(Class c) {
        return args.get(c);
    }
}