Home | History | Annotate | Download | only in program
      1 /*
      2  * Copyright (C) 2014 The Android Open Source Project
      3  *
      4  * Licensed under the Apache License, Version 2.0 (the "License");
      5  * you may not use this file except in compliance with the License.
      6  * You may obtain a copy of the License at
      7  *
      8  *      http://www.apache.org/licenses/LICENSE-2.0
      9  *
     10  * Unless required by applicable law or agreed to in writing, software
     11  * distributed under the License is distributed on an "AS IS" BASIS,
     12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     13  * See the License for the specific language governing permissions and
     14  * limitations under the License.
     15  */
     16 
     17 package dexfuzz.program;
     18 
     19 import dexfuzz.program.mutators.CodeMutator;
     20 
     21 /**
     22  * Mutation should be subclassed by an AssociatedMutation in each CodeMutator,
     23  * which will describe the parameters of the mutation, and override the getString()
     24  * and parseString() methods here to allow serialization of the mutations.
     25  */
     26 public abstract class Mutation {
     27 
     28   public MutatableCode mutatableCode;
     29 
     30   // The first field of any serialized mutation - the mutator that uses it.
     31   public Class<? extends CodeMutator> mutatorClass;
     32   // The second field of any serialized mutation...
     33   // This is an index into the Program's list of MutatableCodes
     34   // i.e., it is NOT an index into the DEX file's CodeItems!
     35   public int mutatableCodeIdx;
     36 
     37   public void setup(Class<? extends CodeMutator> mutatorClass, MutatableCode mutatableCode) {
     38     this.mutatorClass = mutatorClass;
     39     this.mutatableCode = mutatableCode;
     40     this.mutatableCodeIdx = mutatableCode.mutatableCodeIdx;
     41   }
     42   /**
     43    * Serializes the field(s) of the mutation to string format.
     44    * The fields are separated by a space.
     45    * @return the serialized string representation of the field(s) of the mutation.
     46    */
     47   public abstract String getString();
     48 
     49   /**
     50    * Deserializes the strings back to the field(s) of the mutation,
     51    * given a string array as its argument. The string array
     52    * contains the individual elements which were previously constructed by
     53    * getstring() method. elements[0] stores the class name and elements[1]
     54    * stores the mutable code index which are predefined in MutationSerializer.java.
     55    * Users can deserialize the string representation in elements[2] and so forth.
     56    * @param elements string array with serialized representations of the field(s) of the mutation.
     57    */
     58   public abstract void parseString(String[] elements);
     59 }